From 83bb1a31f75bfd2717428f2fed287eb1e830302f Mon Sep 17 00:00:00 2001 From: James Rich <2199651+jamesarich@users.noreply.github.com> Date: Tue, 19 May 2026 10:12:04 -0500 Subject: [PATCH] chore: Scheduled updates (Firmware, Hardware, Translations, Graphs) (#5465) --- androidApp/README.md | 1 + .../src/main/assets/device_hardware.json | 15 ++ .../composeResources/values-ar/strings.xml | 2 + .../composeResources/values-be/strings.xml | 3 + .../composeResources/values-bg/strings.xml | 7 + .../composeResources/values-ca/strings.xml | 1 + .../composeResources/values-cs/strings.xml | 6 + .../composeResources/values-de/strings.xml | 23 ++ .../composeResources/values-el/strings.xml | 2 + .../composeResources/values-es/strings.xml | 6 + .../composeResources/values-et/strings.xml | 21 ++ .../composeResources/values-fi/strings.xml | 6 + .../composeResources/values-fr/strings.xml | 6 + .../composeResources/values-ga/strings.xml | 1 + .../composeResources/values-gl/strings.xml | 1 + .../composeResources/values-he/strings.xml | 1 + .../composeResources/values-hr/strings.xml | 1 + .../composeResources/values-ht/strings.xml | 1 + .../composeResources/values-hu/strings.xml | 4 + .../composeResources/values-is/strings.xml | 1 + .../composeResources/values-it/strings.xml | 6 + .../composeResources/values-ja/strings.xml | 6 + .../composeResources/values-ko/strings.xml | 3 + .../composeResources/values-lt/strings.xml | 1 + .../composeResources/values-nl/strings.xml | 2 + .../composeResources/values-no/strings.xml | 1 + .../composeResources/values-pl/strings.xml | 4 + .../values-pt-rBR/strings.xml | 5 + .../composeResources/values-pt/strings.xml | 4 + .../composeResources/values-ro/strings.xml | 5 + .../composeResources/values-ru/strings.xml | 55 +++- .../composeResources/values-sk/strings.xml | 3 + .../composeResources/values-sl/strings.xml | 1 + .../composeResources/values-sq/strings.xml | 1 + .../composeResources/values-sr/strings.xml | 3 + .../composeResources/values-srp/strings.xml | 3 + .../composeResources/values-sv/strings.xml | 6 + .../composeResources/values-tr/strings.xml | 5 + .../composeResources/values-uk/strings.xml | 4 + .../values-zh-rCN/strings.xml | 7 + .../values-zh-rTW/strings.xml | 7 + docs/ar-rSA/index.md | 30 +++ docs/ar-rSA/user/connections.md | 125 +++++++++ docs/ar-rSA/user/desktop.md | 147 +++++++++++ docs/ar-rSA/user/discovery.md | 114 ++++++++ docs/ar-rSA/user/firmware.md | 114 ++++++++ docs/ar-rSA/user/map-and-waypoints.md | 116 +++++++++ docs/ar-rSA/user/messages-and-channels.md | 159 +++++++++++ docs/ar-rSA/user/mqtt.md | 137 ++++++++++ docs/ar-rSA/user/node-metrics.md | 130 +++++++++ docs/ar-rSA/user/nodes.md | 152 +++++++++++ docs/ar-rSA/user/onboarding.md | 99 +++++++ docs/ar-rSA/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ar-rSA/user/settings-radio-user.md | 173 ++++++++++++ docs/ar-rSA/user/signal-meter.md | 81 ++++++ docs/ar-rSA/user/tak.md | 126 +++++++++ docs/ar-rSA/user/telemetry-and-sensors.md | 118 +++++++++ docs/ar-rSA/user/translate.md | 97 +++++++ docs/ar-rSA/user/units-and-locale.md | 118 +++++++++ docs/be-rBY/index.md | 30 +++ docs/be-rBY/user/connections.md | 125 +++++++++ docs/be-rBY/user/desktop.md | 147 +++++++++++ docs/be-rBY/user/discovery.md | 114 ++++++++ docs/be-rBY/user/firmware.md | 114 ++++++++ docs/be-rBY/user/map-and-waypoints.md | 116 +++++++++ docs/be-rBY/user/messages-and-channels.md | 159 +++++++++++ docs/be-rBY/user/mqtt.md | 137 ++++++++++ docs/be-rBY/user/node-metrics.md | 130 +++++++++ docs/be-rBY/user/nodes.md | 152 +++++++++++ docs/be-rBY/user/onboarding.md | 99 +++++++ docs/be-rBY/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/be-rBY/user/settings-radio-user.md | 173 ++++++++++++ docs/be-rBY/user/signal-meter.md | 81 ++++++ docs/be-rBY/user/tak.md | 126 +++++++++ docs/be-rBY/user/telemetry-and-sensors.md | 118 +++++++++ docs/be-rBY/user/translate.md | 97 +++++++ docs/be-rBY/user/units-and-locale.md | 118 +++++++++ docs/bg-rBG/index.md | 30 +++ docs/bg-rBG/user/connections.md | 125 +++++++++ docs/bg-rBG/user/desktop.md | 147 +++++++++++ docs/bg-rBG/user/discovery.md | 114 ++++++++ docs/bg-rBG/user/firmware.md | 114 ++++++++ docs/bg-rBG/user/map-and-waypoints.md | 116 +++++++++ docs/bg-rBG/user/messages-and-channels.md | 159 +++++++++++ docs/bg-rBG/user/mqtt.md | 137 ++++++++++ docs/bg-rBG/user/node-metrics.md | 130 +++++++++ docs/bg-rBG/user/nodes.md | 152 +++++++++++ docs/bg-rBG/user/onboarding.md | 99 +++++++ docs/bg-rBG/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/bg-rBG/user/settings-radio-user.md | 173 ++++++++++++ docs/bg-rBG/user/signal-meter.md | 81 ++++++ docs/bg-rBG/user/tak.md | 126 +++++++++ docs/bg-rBG/user/telemetry-and-sensors.md | 118 +++++++++ docs/bg-rBG/user/translate.md | 97 +++++++ docs/bg-rBG/user/units-and-locale.md | 118 +++++++++ docs/ca-rES/index.md | 30 +++ docs/ca-rES/user/connections.md | 125 +++++++++ docs/ca-rES/user/desktop.md | 147 +++++++++++ docs/ca-rES/user/discovery.md | 114 ++++++++ docs/ca-rES/user/firmware.md | 114 ++++++++ docs/ca-rES/user/map-and-waypoints.md | 116 +++++++++ docs/ca-rES/user/messages-and-channels.md | 159 +++++++++++ docs/ca-rES/user/mqtt.md | 137 ++++++++++ docs/ca-rES/user/node-metrics.md | 130 +++++++++ docs/ca-rES/user/nodes.md | 152 +++++++++++ docs/ca-rES/user/onboarding.md | 99 +++++++ docs/ca-rES/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ca-rES/user/settings-radio-user.md | 173 ++++++++++++ docs/ca-rES/user/signal-meter.md | 81 ++++++ docs/ca-rES/user/tak.md | 126 +++++++++ docs/ca-rES/user/telemetry-and-sensors.md | 118 +++++++++ docs/ca-rES/user/translate.md | 97 +++++++ docs/ca-rES/user/units-and-locale.md | 118 +++++++++ docs/cs-rCZ/index.md | 30 +++ docs/cs-rCZ/user/connections.md | 125 +++++++++ docs/cs-rCZ/user/desktop.md | 147 +++++++++++ docs/cs-rCZ/user/discovery.md | 114 ++++++++ docs/cs-rCZ/user/firmware.md | 114 ++++++++ docs/cs-rCZ/user/map-and-waypoints.md | 116 +++++++++ docs/cs-rCZ/user/messages-and-channels.md | 159 +++++++++++ docs/cs-rCZ/user/mqtt.md | 137 ++++++++++ docs/cs-rCZ/user/node-metrics.md | 130 +++++++++ docs/cs-rCZ/user/nodes.md | 152 +++++++++++ docs/cs-rCZ/user/onboarding.md | 99 +++++++ docs/cs-rCZ/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/cs-rCZ/user/settings-radio-user.md | 173 ++++++++++++ docs/cs-rCZ/user/signal-meter.md | 81 ++++++ docs/cs-rCZ/user/tak.md | 126 +++++++++ docs/cs-rCZ/user/telemetry-and-sensors.md | 118 +++++++++ docs/cs-rCZ/user/translate.md | 97 +++++++ docs/cs-rCZ/user/units-and-locale.md | 118 +++++++++ docs/de-rDE/index.md | 30 +++ docs/de-rDE/user/connections.md | 125 +++++++++ docs/de-rDE/user/desktop.md | 147 +++++++++++ docs/de-rDE/user/discovery.md | 114 ++++++++ docs/de-rDE/user/firmware.md | 114 ++++++++ docs/de-rDE/user/map-and-waypoints.md | 116 +++++++++ docs/de-rDE/user/messages-and-channels.md | 159 +++++++++++ docs/de-rDE/user/mqtt.md | 137 ++++++++++ docs/de-rDE/user/node-metrics.md | 130 +++++++++ docs/de-rDE/user/nodes.md | 152 +++++++++++ docs/de-rDE/user/onboarding.md | 99 +++++++ docs/de-rDE/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/de-rDE/user/settings-radio-user.md | 173 ++++++++++++ docs/de-rDE/user/signal-meter.md | 81 ++++++ docs/de-rDE/user/tak.md | 126 +++++++++ docs/de-rDE/user/telemetry-and-sensors.md | 118 +++++++++ docs/de-rDE/user/translate.md | 97 +++++++ docs/de-rDE/user/units-and-locale.md | 118 +++++++++ docs/el-rGR/index.md | 30 +++ docs/el-rGR/user/connections.md | 125 +++++++++ docs/el-rGR/user/desktop.md | 147 +++++++++++ docs/el-rGR/user/discovery.md | 114 ++++++++ docs/el-rGR/user/firmware.md | 114 ++++++++ docs/el-rGR/user/map-and-waypoints.md | 116 +++++++++ docs/el-rGR/user/messages-and-channels.md | 159 +++++++++++ docs/el-rGR/user/mqtt.md | 137 ++++++++++ docs/el-rGR/user/node-metrics.md | 130 +++++++++ docs/el-rGR/user/nodes.md | 152 +++++++++++ docs/el-rGR/user/onboarding.md | 99 +++++++ docs/el-rGR/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/el-rGR/user/settings-radio-user.md | 173 ++++++++++++ docs/el-rGR/user/signal-meter.md | 81 ++++++ docs/el-rGR/user/tak.md | 126 +++++++++ docs/el-rGR/user/telemetry-and-sensors.md | 118 +++++++++ docs/el-rGR/user/translate.md | 97 +++++++ docs/el-rGR/user/units-and-locale.md | 118 +++++++++ docs/es-rES/index.md | 30 +++ docs/es-rES/user/connections.md | 125 +++++++++ docs/es-rES/user/desktop.md | 147 +++++++++++ docs/es-rES/user/discovery.md | 114 ++++++++ docs/es-rES/user/firmware.md | 114 ++++++++ docs/es-rES/user/map-and-waypoints.md | 116 +++++++++ docs/es-rES/user/messages-and-channels.md | 159 +++++++++++ docs/es-rES/user/mqtt.md | 137 ++++++++++ docs/es-rES/user/node-metrics.md | 130 +++++++++ docs/es-rES/user/nodes.md | 152 +++++++++++ docs/es-rES/user/onboarding.md | 99 +++++++ docs/es-rES/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/es-rES/user/settings-radio-user.md | 173 ++++++++++++ docs/es-rES/user/signal-meter.md | 81 ++++++ docs/es-rES/user/tak.md | 126 +++++++++ docs/es-rES/user/telemetry-and-sensors.md | 118 +++++++++ docs/es-rES/user/translate.md | 97 +++++++ docs/es-rES/user/units-and-locale.md | 118 +++++++++ docs/et-rEE/index.md | 30 +++ docs/et-rEE/user/connections.md | 125 +++++++++ docs/et-rEE/user/desktop.md | 147 +++++++++++ docs/et-rEE/user/discovery.md | 114 ++++++++ docs/et-rEE/user/firmware.md | 114 ++++++++ docs/et-rEE/user/map-and-waypoints.md | 116 +++++++++ docs/et-rEE/user/messages-and-channels.md | 159 +++++++++++ docs/et-rEE/user/mqtt.md | 137 ++++++++++ docs/et-rEE/user/node-metrics.md | 130 +++++++++ docs/et-rEE/user/nodes.md | 152 +++++++++++ docs/et-rEE/user/onboarding.md | 99 +++++++ docs/et-rEE/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/et-rEE/user/settings-radio-user.md | 173 ++++++++++++ docs/et-rEE/user/signal-meter.md | 81 ++++++ docs/et-rEE/user/tak.md | 126 +++++++++ docs/et-rEE/user/telemetry-and-sensors.md | 118 +++++++++ docs/et-rEE/user/translate.md | 97 +++++++ docs/et-rEE/user/units-and-locale.md | 118 +++++++++ docs/fi-rFI/index.md | 30 +++ docs/fi-rFI/user/connections.md | 125 +++++++++ docs/fi-rFI/user/desktop.md | 147 +++++++++++ docs/fi-rFI/user/discovery.md | 114 ++++++++ docs/fi-rFI/user/firmware.md | 114 ++++++++ docs/fi-rFI/user/map-and-waypoints.md | 116 +++++++++ docs/fi-rFI/user/messages-and-channels.md | 159 +++++++++++ docs/fi-rFI/user/mqtt.md | 137 ++++++++++ docs/fi-rFI/user/node-metrics.md | 130 +++++++++ docs/fi-rFI/user/nodes.md | 152 +++++++++++ docs/fi-rFI/user/onboarding.md | 99 +++++++ docs/fi-rFI/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/fi-rFI/user/settings-radio-user.md | 173 ++++++++++++ docs/fi-rFI/user/signal-meter.md | 81 ++++++ docs/fi-rFI/user/tak.md | 126 +++++++++ docs/fi-rFI/user/telemetry-and-sensors.md | 118 +++++++++ docs/fi-rFI/user/translate.md | 97 +++++++ docs/fi-rFI/user/units-and-locale.md | 118 +++++++++ docs/fr-rFR/index.md | 30 +++ docs/fr-rFR/user/connections.md | 125 +++++++++ docs/fr-rFR/user/desktop.md | 147 +++++++++++ docs/fr-rFR/user/discovery.md | 114 ++++++++ docs/fr-rFR/user/firmware.md | 114 ++++++++ docs/fr-rFR/user/map-and-waypoints.md | 116 +++++++++ docs/fr-rFR/user/messages-and-channels.md | 159 +++++++++++ docs/fr-rFR/user/mqtt.md | 137 ++++++++++ docs/fr-rFR/user/node-metrics.md | 130 +++++++++ docs/fr-rFR/user/nodes.md | 152 +++++++++++ docs/fr-rFR/user/onboarding.md | 99 +++++++ docs/fr-rFR/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/fr-rFR/user/settings-radio-user.md | 173 ++++++++++++ docs/fr-rFR/user/signal-meter.md | 81 ++++++ docs/fr-rFR/user/tak.md | 126 +++++++++ docs/fr-rFR/user/telemetry-and-sensors.md | 118 +++++++++ docs/fr-rFR/user/translate.md | 97 +++++++ docs/fr-rFR/user/units-and-locale.md | 118 +++++++++ docs/ga-rIE/index.md | 30 +++ docs/ga-rIE/user/connections.md | 125 +++++++++ docs/ga-rIE/user/desktop.md | 147 +++++++++++ docs/ga-rIE/user/discovery.md | 114 ++++++++ docs/ga-rIE/user/firmware.md | 114 ++++++++ docs/ga-rIE/user/map-and-waypoints.md | 116 +++++++++ docs/ga-rIE/user/messages-and-channels.md | 159 +++++++++++ docs/ga-rIE/user/mqtt.md | 137 ++++++++++ docs/ga-rIE/user/node-metrics.md | 130 +++++++++ docs/ga-rIE/user/nodes.md | 152 +++++++++++ docs/ga-rIE/user/onboarding.md | 99 +++++++ docs/ga-rIE/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ga-rIE/user/settings-radio-user.md | 173 ++++++++++++ docs/ga-rIE/user/signal-meter.md | 81 ++++++ docs/ga-rIE/user/tak.md | 126 +++++++++ docs/ga-rIE/user/telemetry-and-sensors.md | 118 +++++++++ docs/ga-rIE/user/translate.md | 97 +++++++ docs/ga-rIE/user/units-and-locale.md | 118 +++++++++ docs/gl-rES/index.md | 30 +++ docs/gl-rES/user/connections.md | 125 +++++++++ docs/gl-rES/user/desktop.md | 147 +++++++++++ docs/gl-rES/user/discovery.md | 114 ++++++++ docs/gl-rES/user/firmware.md | 114 ++++++++ docs/gl-rES/user/map-and-waypoints.md | 116 +++++++++ docs/gl-rES/user/messages-and-channels.md | 159 +++++++++++ docs/gl-rES/user/mqtt.md | 137 ++++++++++ docs/gl-rES/user/node-metrics.md | 130 +++++++++ docs/gl-rES/user/nodes.md | 152 +++++++++++ docs/gl-rES/user/onboarding.md | 99 +++++++ docs/gl-rES/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/gl-rES/user/settings-radio-user.md | 173 ++++++++++++ docs/gl-rES/user/signal-meter.md | 81 ++++++ docs/gl-rES/user/tak.md | 126 +++++++++ docs/gl-rES/user/telemetry-and-sensors.md | 118 +++++++++ docs/gl-rES/user/translate.md | 97 +++++++ docs/gl-rES/user/units-and-locale.md | 118 +++++++++ docs/hr-rHR/index.md | 30 +++ docs/hr-rHR/user/connections.md | 125 +++++++++ docs/hr-rHR/user/desktop.md | 147 +++++++++++ docs/hr-rHR/user/discovery.md | 114 ++++++++ docs/hr-rHR/user/firmware.md | 114 ++++++++ docs/hr-rHR/user/map-and-waypoints.md | 116 +++++++++ docs/hr-rHR/user/messages-and-channels.md | 159 +++++++++++ docs/hr-rHR/user/mqtt.md | 137 ++++++++++ docs/hr-rHR/user/node-metrics.md | 130 +++++++++ docs/hr-rHR/user/nodes.md | 152 +++++++++++ docs/hr-rHR/user/onboarding.md | 99 +++++++ docs/hr-rHR/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/hr-rHR/user/settings-radio-user.md | 173 ++++++++++++ docs/hr-rHR/user/signal-meter.md | 81 ++++++ docs/hr-rHR/user/tak.md | 126 +++++++++ docs/hr-rHR/user/telemetry-and-sensors.md | 118 +++++++++ docs/hr-rHR/user/translate.md | 97 +++++++ docs/hr-rHR/user/units-and-locale.md | 118 +++++++++ docs/ht-rHT/index.md | 30 +++ docs/ht-rHT/user/connections.md | 125 +++++++++ docs/ht-rHT/user/desktop.md | 147 +++++++++++ docs/ht-rHT/user/discovery.md | 114 ++++++++ docs/ht-rHT/user/firmware.md | 114 ++++++++ docs/ht-rHT/user/map-and-waypoints.md | 116 +++++++++ docs/ht-rHT/user/messages-and-channels.md | 159 +++++++++++ docs/ht-rHT/user/mqtt.md | 137 ++++++++++ docs/ht-rHT/user/node-metrics.md | 130 +++++++++ docs/ht-rHT/user/nodes.md | 152 +++++++++++ docs/ht-rHT/user/onboarding.md | 99 +++++++ docs/ht-rHT/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ht-rHT/user/settings-radio-user.md | 173 ++++++++++++ docs/ht-rHT/user/signal-meter.md | 81 ++++++ docs/ht-rHT/user/tak.md | 126 +++++++++ docs/ht-rHT/user/telemetry-and-sensors.md | 118 +++++++++ docs/ht-rHT/user/translate.md | 97 +++++++ docs/ht-rHT/user/units-and-locale.md | 118 +++++++++ docs/hu-rHU/index.md | 30 +++ docs/hu-rHU/user/connections.md | 125 +++++++++ docs/hu-rHU/user/desktop.md | 147 +++++++++++ docs/hu-rHU/user/discovery.md | 114 ++++++++ docs/hu-rHU/user/firmware.md | 114 ++++++++ docs/hu-rHU/user/map-and-waypoints.md | 116 +++++++++ docs/hu-rHU/user/messages-and-channels.md | 159 +++++++++++ docs/hu-rHU/user/mqtt.md | 137 ++++++++++ docs/hu-rHU/user/node-metrics.md | 130 +++++++++ docs/hu-rHU/user/nodes.md | 152 +++++++++++ docs/hu-rHU/user/onboarding.md | 99 +++++++ docs/hu-rHU/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/hu-rHU/user/settings-radio-user.md | 173 ++++++++++++ docs/hu-rHU/user/signal-meter.md | 81 ++++++ docs/hu-rHU/user/tak.md | 126 +++++++++ docs/hu-rHU/user/telemetry-and-sensors.md | 118 +++++++++ docs/hu-rHU/user/translate.md | 97 +++++++ docs/hu-rHU/user/units-and-locale.md | 118 +++++++++ docs/is-rIS/index.md | 30 +++ docs/is-rIS/user/connections.md | 125 +++++++++ docs/is-rIS/user/desktop.md | 147 +++++++++++ docs/is-rIS/user/discovery.md | 114 ++++++++ docs/is-rIS/user/firmware.md | 114 ++++++++ docs/is-rIS/user/map-and-waypoints.md | 116 +++++++++ docs/is-rIS/user/messages-and-channels.md | 159 +++++++++++ docs/is-rIS/user/mqtt.md | 137 ++++++++++ docs/is-rIS/user/node-metrics.md | 130 +++++++++ docs/is-rIS/user/nodes.md | 152 +++++++++++ docs/is-rIS/user/onboarding.md | 99 +++++++ docs/is-rIS/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/is-rIS/user/settings-radio-user.md | 173 ++++++++++++ docs/is-rIS/user/signal-meter.md | 81 ++++++ docs/is-rIS/user/tak.md | 126 +++++++++ docs/is-rIS/user/telemetry-and-sensors.md | 118 +++++++++ docs/is-rIS/user/translate.md | 97 +++++++ docs/is-rIS/user/units-and-locale.md | 118 +++++++++ docs/it-rIT/index.md | 30 +++ docs/it-rIT/user/connections.md | 125 +++++++++ docs/it-rIT/user/desktop.md | 147 +++++++++++ docs/it-rIT/user/discovery.md | 114 ++++++++ docs/it-rIT/user/firmware.md | 114 ++++++++ docs/it-rIT/user/map-and-waypoints.md | 116 +++++++++ docs/it-rIT/user/messages-and-channels.md | 159 +++++++++++ docs/it-rIT/user/mqtt.md | 137 ++++++++++ docs/it-rIT/user/node-metrics.md | 130 +++++++++ docs/it-rIT/user/nodes.md | 152 +++++++++++ docs/it-rIT/user/onboarding.md | 99 +++++++ docs/it-rIT/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/it-rIT/user/settings-radio-user.md | 173 ++++++++++++ docs/it-rIT/user/signal-meter.md | 81 ++++++ docs/it-rIT/user/tak.md | 126 +++++++++ docs/it-rIT/user/telemetry-and-sensors.md | 118 +++++++++ docs/it-rIT/user/translate.md | 97 +++++++ docs/it-rIT/user/units-and-locale.md | 118 +++++++++ docs/iw-rIL/index.md | 30 +++ docs/iw-rIL/user/connections.md | 125 +++++++++ docs/iw-rIL/user/desktop.md | 147 +++++++++++ docs/iw-rIL/user/discovery.md | 114 ++++++++ docs/iw-rIL/user/firmware.md | 114 ++++++++ docs/iw-rIL/user/map-and-waypoints.md | 116 +++++++++ docs/iw-rIL/user/messages-and-channels.md | 159 +++++++++++ docs/iw-rIL/user/mqtt.md | 137 ++++++++++ docs/iw-rIL/user/node-metrics.md | 130 +++++++++ docs/iw-rIL/user/nodes.md | 152 +++++++++++ docs/iw-rIL/user/onboarding.md | 99 +++++++ docs/iw-rIL/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/iw-rIL/user/settings-radio-user.md | 173 ++++++++++++ docs/iw-rIL/user/signal-meter.md | 81 ++++++ docs/iw-rIL/user/tak.md | 126 +++++++++ docs/iw-rIL/user/telemetry-and-sensors.md | 118 +++++++++ docs/iw-rIL/user/translate.md | 97 +++++++ docs/iw-rIL/user/units-and-locale.md | 118 +++++++++ docs/ja-rJP/index.md | 30 +++ docs/ja-rJP/user/connections.md | 125 +++++++++ docs/ja-rJP/user/desktop.md | 147 +++++++++++ docs/ja-rJP/user/discovery.md | 114 ++++++++ docs/ja-rJP/user/firmware.md | 114 ++++++++ docs/ja-rJP/user/map-and-waypoints.md | 116 +++++++++ docs/ja-rJP/user/messages-and-channels.md | 159 +++++++++++ docs/ja-rJP/user/mqtt.md | 137 ++++++++++ docs/ja-rJP/user/node-metrics.md | 130 +++++++++ docs/ja-rJP/user/nodes.md | 152 +++++++++++ docs/ja-rJP/user/onboarding.md | 99 +++++++ docs/ja-rJP/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ja-rJP/user/settings-radio-user.md | 173 ++++++++++++ docs/ja-rJP/user/signal-meter.md | 81 ++++++ docs/ja-rJP/user/tak.md | 126 +++++++++ docs/ja-rJP/user/telemetry-and-sensors.md | 118 +++++++++ docs/ja-rJP/user/translate.md | 97 +++++++ docs/ja-rJP/user/units-and-locale.md | 118 +++++++++ docs/ko-rKR/index.md | 30 +++ docs/ko-rKR/user/connections.md | 125 +++++++++ docs/ko-rKR/user/desktop.md | 147 +++++++++++ docs/ko-rKR/user/discovery.md | 114 ++++++++ docs/ko-rKR/user/firmware.md | 114 ++++++++ docs/ko-rKR/user/map-and-waypoints.md | 116 +++++++++ docs/ko-rKR/user/messages-and-channels.md | 159 +++++++++++ docs/ko-rKR/user/mqtt.md | 137 ++++++++++ docs/ko-rKR/user/node-metrics.md | 130 +++++++++ docs/ko-rKR/user/nodes.md | 152 +++++++++++ docs/ko-rKR/user/onboarding.md | 99 +++++++ docs/ko-rKR/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ko-rKR/user/settings-radio-user.md | 173 ++++++++++++ docs/ko-rKR/user/signal-meter.md | 81 ++++++ docs/ko-rKR/user/tak.md | 126 +++++++++ docs/ko-rKR/user/telemetry-and-sensors.md | 118 +++++++++ docs/ko-rKR/user/translate.md | 97 +++++++ docs/ko-rKR/user/units-and-locale.md | 118 +++++++++ docs/lt-rLT/index.md | 30 +++ docs/lt-rLT/user/connections.md | 125 +++++++++ docs/lt-rLT/user/desktop.md | 147 +++++++++++ docs/lt-rLT/user/discovery.md | 114 ++++++++ docs/lt-rLT/user/firmware.md | 114 ++++++++ docs/lt-rLT/user/map-and-waypoints.md | 116 +++++++++ docs/lt-rLT/user/messages-and-channels.md | 159 +++++++++++ docs/lt-rLT/user/mqtt.md | 137 ++++++++++ docs/lt-rLT/user/node-metrics.md | 130 +++++++++ docs/lt-rLT/user/nodes.md | 152 +++++++++++ docs/lt-rLT/user/onboarding.md | 99 +++++++ docs/lt-rLT/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/lt-rLT/user/settings-radio-user.md | 173 ++++++++++++ docs/lt-rLT/user/signal-meter.md | 81 ++++++ docs/lt-rLT/user/tak.md | 126 +++++++++ docs/lt-rLT/user/telemetry-and-sensors.md | 118 +++++++++ docs/lt-rLT/user/translate.md | 97 +++++++ docs/lt-rLT/user/units-and-locale.md | 118 +++++++++ docs/nl-rNL/index.md | 30 +++ docs/nl-rNL/user/connections.md | 125 +++++++++ docs/nl-rNL/user/desktop.md | 147 +++++++++++ docs/nl-rNL/user/discovery.md | 114 ++++++++ docs/nl-rNL/user/firmware.md | 114 ++++++++ docs/nl-rNL/user/map-and-waypoints.md | 116 +++++++++ docs/nl-rNL/user/messages-and-channels.md | 159 +++++++++++ docs/nl-rNL/user/mqtt.md | 137 ++++++++++ docs/nl-rNL/user/node-metrics.md | 130 +++++++++ docs/nl-rNL/user/nodes.md | 152 +++++++++++ docs/nl-rNL/user/onboarding.md | 99 +++++++ docs/nl-rNL/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/nl-rNL/user/settings-radio-user.md | 173 ++++++++++++ docs/nl-rNL/user/signal-meter.md | 81 ++++++ docs/nl-rNL/user/tak.md | 126 +++++++++ docs/nl-rNL/user/telemetry-and-sensors.md | 118 +++++++++ docs/nl-rNL/user/translate.md | 97 +++++++ docs/nl-rNL/user/units-and-locale.md | 118 +++++++++ docs/no-rNO/index.md | 30 +++ docs/no-rNO/user/connections.md | 125 +++++++++ docs/no-rNO/user/desktop.md | 147 +++++++++++ docs/no-rNO/user/discovery.md | 114 ++++++++ docs/no-rNO/user/firmware.md | 114 ++++++++ docs/no-rNO/user/map-and-waypoints.md | 116 +++++++++ docs/no-rNO/user/messages-and-channels.md | 159 +++++++++++ docs/no-rNO/user/mqtt.md | 137 ++++++++++ docs/no-rNO/user/node-metrics.md | 130 +++++++++ docs/no-rNO/user/nodes.md | 152 +++++++++++ docs/no-rNO/user/onboarding.md | 99 +++++++ docs/no-rNO/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/no-rNO/user/settings-radio-user.md | 173 ++++++++++++ docs/no-rNO/user/signal-meter.md | 81 ++++++ docs/no-rNO/user/tak.md | 126 +++++++++ docs/no-rNO/user/telemetry-and-sensors.md | 118 +++++++++ docs/no-rNO/user/translate.md | 97 +++++++ docs/no-rNO/user/units-and-locale.md | 118 +++++++++ docs/pl-rPL/index.md | 30 +++ docs/pl-rPL/user/connections.md | 125 +++++++++ docs/pl-rPL/user/desktop.md | 147 +++++++++++ docs/pl-rPL/user/discovery.md | 114 ++++++++ docs/pl-rPL/user/firmware.md | 114 ++++++++ docs/pl-rPL/user/map-and-waypoints.md | 116 +++++++++ docs/pl-rPL/user/messages-and-channels.md | 159 +++++++++++ docs/pl-rPL/user/mqtt.md | 137 ++++++++++ docs/pl-rPL/user/node-metrics.md | 130 +++++++++ docs/pl-rPL/user/nodes.md | 152 +++++++++++ docs/pl-rPL/user/onboarding.md | 99 +++++++ docs/pl-rPL/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/pl-rPL/user/settings-radio-user.md | 173 ++++++++++++ docs/pl-rPL/user/signal-meter.md | 81 ++++++ docs/pl-rPL/user/tak.md | 126 +++++++++ docs/pl-rPL/user/telemetry-and-sensors.md | 118 +++++++++ docs/pl-rPL/user/translate.md | 97 +++++++ docs/pl-rPL/user/units-and-locale.md | 118 +++++++++ docs/pt-rBR/index.md | 30 +++ docs/pt-rBR/user/connections.md | 125 +++++++++ docs/pt-rBR/user/desktop.md | 147 +++++++++++ docs/pt-rBR/user/discovery.md | 114 ++++++++ docs/pt-rBR/user/firmware.md | 114 ++++++++ docs/pt-rBR/user/map-and-waypoints.md | 116 +++++++++ docs/pt-rBR/user/messages-and-channels.md | 159 +++++++++++ docs/pt-rBR/user/mqtt.md | 137 ++++++++++ docs/pt-rBR/user/node-metrics.md | 130 +++++++++ docs/pt-rBR/user/nodes.md | 152 +++++++++++ docs/pt-rBR/user/onboarding.md | 99 +++++++ docs/pt-rBR/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/pt-rBR/user/settings-radio-user.md | 173 ++++++++++++ docs/pt-rBR/user/signal-meter.md | 81 ++++++ docs/pt-rBR/user/tak.md | 126 +++++++++ docs/pt-rBR/user/telemetry-and-sensors.md | 118 +++++++++ docs/pt-rBR/user/translate.md | 97 +++++++ docs/pt-rBR/user/units-and-locale.md | 118 +++++++++ docs/pt-rPT/index.md | 30 +++ docs/pt-rPT/user/connections.md | 125 +++++++++ docs/pt-rPT/user/desktop.md | 147 +++++++++++ docs/pt-rPT/user/discovery.md | 114 ++++++++ docs/pt-rPT/user/firmware.md | 114 ++++++++ docs/pt-rPT/user/map-and-waypoints.md | 116 +++++++++ docs/pt-rPT/user/messages-and-channels.md | 159 +++++++++++ docs/pt-rPT/user/mqtt.md | 137 ++++++++++ docs/pt-rPT/user/node-metrics.md | 130 +++++++++ docs/pt-rPT/user/nodes.md | 152 +++++++++++ docs/pt-rPT/user/onboarding.md | 99 +++++++ docs/pt-rPT/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/pt-rPT/user/settings-radio-user.md | 173 ++++++++++++ docs/pt-rPT/user/signal-meter.md | 81 ++++++ docs/pt-rPT/user/tak.md | 126 +++++++++ docs/pt-rPT/user/telemetry-and-sensors.md | 118 +++++++++ docs/pt-rPT/user/translate.md | 97 +++++++ docs/pt-rPT/user/units-and-locale.md | 118 +++++++++ docs/ro-rRO/index.md | 30 +++ docs/ro-rRO/user/connections.md | 125 +++++++++ docs/ro-rRO/user/desktop.md | 147 +++++++++++ docs/ro-rRO/user/discovery.md | 114 ++++++++ docs/ro-rRO/user/firmware.md | 114 ++++++++ docs/ro-rRO/user/map-and-waypoints.md | 116 +++++++++ docs/ro-rRO/user/messages-and-channels.md | 159 +++++++++++ docs/ro-rRO/user/mqtt.md | 137 ++++++++++ docs/ro-rRO/user/node-metrics.md | 130 +++++++++ docs/ro-rRO/user/nodes.md | 152 +++++++++++ docs/ro-rRO/user/onboarding.md | 99 +++++++ docs/ro-rRO/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ro-rRO/user/settings-radio-user.md | 173 ++++++++++++ docs/ro-rRO/user/signal-meter.md | 81 ++++++ docs/ro-rRO/user/tak.md | 126 +++++++++ docs/ro-rRO/user/telemetry-and-sensors.md | 118 +++++++++ docs/ro-rRO/user/translate.md | 97 +++++++ docs/ro-rRO/user/units-and-locale.md | 118 +++++++++ docs/ru-rRU/index.md | 30 +++ docs/ru-rRU/user/connections.md | 125 +++++++++ docs/ru-rRU/user/desktop.md | 147 +++++++++++ docs/ru-rRU/user/discovery.md | 114 ++++++++ docs/ru-rRU/user/firmware.md | 114 ++++++++ docs/ru-rRU/user/map-and-waypoints.md | 116 +++++++++ docs/ru-rRU/user/messages-and-channels.md | 159 +++++++++++ docs/ru-rRU/user/mqtt.md | 137 ++++++++++ docs/ru-rRU/user/node-metrics.md | 130 +++++++++ docs/ru-rRU/user/nodes.md | 152 +++++++++++ docs/ru-rRU/user/onboarding.md | 99 +++++++ docs/ru-rRU/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/ru-rRU/user/settings-radio-user.md | 173 ++++++++++++ docs/ru-rRU/user/signal-meter.md | 81 ++++++ docs/ru-rRU/user/tak.md | 126 +++++++++ docs/ru-rRU/user/telemetry-and-sensors.md | 118 +++++++++ docs/ru-rRU/user/translate.md | 96 +++++++ docs/ru-rRU/user/units-and-locale.md | 118 +++++++++ docs/sk-rSK/index.md | 30 +++ docs/sk-rSK/user/connections.md | 125 +++++++++ docs/sk-rSK/user/desktop.md | 147 +++++++++++ docs/sk-rSK/user/discovery.md | 114 ++++++++ docs/sk-rSK/user/firmware.md | 114 ++++++++ docs/sk-rSK/user/map-and-waypoints.md | 116 +++++++++ docs/sk-rSK/user/messages-and-channels.md | 159 +++++++++++ docs/sk-rSK/user/mqtt.md | 137 ++++++++++ docs/sk-rSK/user/node-metrics.md | 130 +++++++++ docs/sk-rSK/user/nodes.md | 152 +++++++++++ docs/sk-rSK/user/onboarding.md | 99 +++++++ docs/sk-rSK/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/sk-rSK/user/settings-radio-user.md | 173 ++++++++++++ docs/sk-rSK/user/signal-meter.md | 81 ++++++ docs/sk-rSK/user/tak.md | 126 +++++++++ docs/sk-rSK/user/telemetry-and-sensors.md | 118 +++++++++ docs/sk-rSK/user/translate.md | 97 +++++++ docs/sk-rSK/user/units-and-locale.md | 118 +++++++++ docs/sl-rSI/index.md | 30 +++ docs/sl-rSI/user/connections.md | 125 +++++++++ docs/sl-rSI/user/desktop.md | 147 +++++++++++ docs/sl-rSI/user/discovery.md | 114 ++++++++ docs/sl-rSI/user/firmware.md | 114 ++++++++ docs/sl-rSI/user/map-and-waypoints.md | 116 +++++++++ docs/sl-rSI/user/messages-and-channels.md | 159 +++++++++++ docs/sl-rSI/user/mqtt.md | 137 ++++++++++ docs/sl-rSI/user/node-metrics.md | 130 +++++++++ docs/sl-rSI/user/nodes.md | 152 +++++++++++ docs/sl-rSI/user/onboarding.md | 99 +++++++ docs/sl-rSI/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/sl-rSI/user/settings-radio-user.md | 173 ++++++++++++ docs/sl-rSI/user/signal-meter.md | 81 ++++++ docs/sl-rSI/user/tak.md | 126 +++++++++ docs/sl-rSI/user/telemetry-and-sensors.md | 118 +++++++++ docs/sl-rSI/user/translate.md | 97 +++++++ docs/sl-rSI/user/units-and-locale.md | 118 +++++++++ docs/sq-rAL/index.md | 30 +++ docs/sq-rAL/user/connections.md | 125 +++++++++ docs/sq-rAL/user/desktop.md | 147 +++++++++++ docs/sq-rAL/user/discovery.md | 114 ++++++++ docs/sq-rAL/user/firmware.md | 114 ++++++++ docs/sq-rAL/user/map-and-waypoints.md | 116 +++++++++ docs/sq-rAL/user/messages-and-channels.md | 159 +++++++++++ docs/sq-rAL/user/mqtt.md | 137 ++++++++++ docs/sq-rAL/user/node-metrics.md | 130 +++++++++ docs/sq-rAL/user/nodes.md | 152 +++++++++++ docs/sq-rAL/user/onboarding.md | 99 +++++++ docs/sq-rAL/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/sq-rAL/user/settings-radio-user.md | 173 ++++++++++++ docs/sq-rAL/user/signal-meter.md | 81 ++++++ docs/sq-rAL/user/tak.md | 126 +++++++++ docs/sq-rAL/user/telemetry-and-sensors.md | 118 +++++++++ docs/sq-rAL/user/translate.md | 97 +++++++ docs/sq-rAL/user/units-and-locale.md | 118 +++++++++ docs/sr-rLatn/index.md | 30 +++ docs/sr-rLatn/user/connections.md | 125 +++++++++ docs/sr-rLatn/user/desktop.md | 147 +++++++++++ docs/sr-rLatn/user/discovery.md | 114 ++++++++ docs/sr-rLatn/user/firmware.md | 114 ++++++++ docs/sr-rLatn/user/map-and-waypoints.md | 116 +++++++++ docs/sr-rLatn/user/messages-and-channels.md | 159 +++++++++++ docs/sr-rLatn/user/mqtt.md | 137 ++++++++++ docs/sr-rLatn/user/node-metrics.md | 130 +++++++++ docs/sr-rLatn/user/nodes.md | 152 +++++++++++ docs/sr-rLatn/user/onboarding.md | 99 +++++++ docs/sr-rLatn/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/sr-rLatn/user/settings-radio-user.md | 173 ++++++++++++ docs/sr-rLatn/user/signal-meter.md | 81 ++++++ docs/sr-rLatn/user/tak.md | 126 +++++++++ docs/sr-rLatn/user/telemetry-and-sensors.md | 118 +++++++++ docs/sr-rLatn/user/translate.md | 97 +++++++ docs/sr-rLatn/user/units-and-locale.md | 118 +++++++++ docs/srp/index.md | 30 +++ docs/srp/user/connections.md | 125 +++++++++ docs/srp/user/desktop.md | 147 +++++++++++ docs/srp/user/discovery.md | 114 ++++++++ docs/srp/user/firmware.md | 114 ++++++++ docs/srp/user/map-and-waypoints.md | 116 +++++++++ docs/srp/user/messages-and-channels.md | 159 +++++++++++ docs/srp/user/mqtt.md | 137 ++++++++++ docs/srp/user/node-metrics.md | 130 +++++++++ docs/srp/user/nodes.md | 152 +++++++++++ docs/srp/user/onboarding.md | 99 +++++++ docs/srp/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/srp/user/settings-radio-user.md | 173 ++++++++++++ docs/srp/user/signal-meter.md | 81 ++++++ docs/srp/user/tak.md | 126 +++++++++ docs/srp/user/telemetry-and-sensors.md | 118 +++++++++ docs/srp/user/translate.md | 97 +++++++ docs/srp/user/units-and-locale.md | 118 +++++++++ docs/sv-rSE/index.md | 30 +++ docs/sv-rSE/user/connections.md | 125 +++++++++ docs/sv-rSE/user/desktop.md | 147 +++++++++++ docs/sv-rSE/user/discovery.md | 114 ++++++++ docs/sv-rSE/user/firmware.md | 114 ++++++++ docs/sv-rSE/user/map-and-waypoints.md | 116 +++++++++ docs/sv-rSE/user/messages-and-channels.md | 159 +++++++++++ docs/sv-rSE/user/mqtt.md | 137 ++++++++++ docs/sv-rSE/user/node-metrics.md | 130 +++++++++ docs/sv-rSE/user/nodes.md | 152 +++++++++++ docs/sv-rSE/user/onboarding.md | 99 +++++++ docs/sv-rSE/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/sv-rSE/user/settings-radio-user.md | 173 ++++++++++++ docs/sv-rSE/user/signal-meter.md | 81 ++++++ docs/sv-rSE/user/tak.md | 126 +++++++++ docs/sv-rSE/user/telemetry-and-sensors.md | 118 +++++++++ docs/sv-rSE/user/translate.md | 97 +++++++ docs/sv-rSE/user/units-and-locale.md | 118 +++++++++ docs/tr-rTR/index.md | 30 +++ docs/tr-rTR/user/connections.md | 125 +++++++++ docs/tr-rTR/user/desktop.md | 147 +++++++++++ docs/tr-rTR/user/discovery.md | 114 ++++++++ docs/tr-rTR/user/firmware.md | 114 ++++++++ docs/tr-rTR/user/map-and-waypoints.md | 116 +++++++++ docs/tr-rTR/user/messages-and-channels.md | 159 +++++++++++ docs/tr-rTR/user/mqtt.md | 137 ++++++++++ docs/tr-rTR/user/node-metrics.md | 130 +++++++++ docs/tr-rTR/user/nodes.md | 152 +++++++++++ docs/tr-rTR/user/onboarding.md | 99 +++++++ docs/tr-rTR/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/tr-rTR/user/settings-radio-user.md | 173 ++++++++++++ docs/tr-rTR/user/signal-meter.md | 81 ++++++ docs/tr-rTR/user/tak.md | 126 +++++++++ docs/tr-rTR/user/telemetry-and-sensors.md | 118 +++++++++ docs/tr-rTR/user/translate.md | 97 +++++++ docs/tr-rTR/user/units-and-locale.md | 118 +++++++++ docs/uk-rUA/index.md | 30 +++ docs/uk-rUA/user/connections.md | 125 +++++++++ docs/uk-rUA/user/desktop.md | 147 +++++++++++ docs/uk-rUA/user/discovery.md | 114 ++++++++ docs/uk-rUA/user/firmware.md | 114 ++++++++ docs/uk-rUA/user/map-and-waypoints.md | 116 +++++++++ docs/uk-rUA/user/messages-and-channels.md | 159 +++++++++++ docs/uk-rUA/user/mqtt.md | 137 ++++++++++ docs/uk-rUA/user/node-metrics.md | 130 +++++++++ docs/uk-rUA/user/nodes.md | 152 +++++++++++ docs/uk-rUA/user/onboarding.md | 99 +++++++ docs/uk-rUA/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/uk-rUA/user/settings-radio-user.md | 173 ++++++++++++ docs/uk-rUA/user/signal-meter.md | 81 ++++++ docs/uk-rUA/user/tak.md | 126 +++++++++ docs/uk-rUA/user/telemetry-and-sensors.md | 118 +++++++++ docs/uk-rUA/user/translate.md | 97 +++++++ docs/uk-rUA/user/units-and-locale.md | 118 +++++++++ docs/zh-rCN/index.md | 30 +++ docs/zh-rCN/user/connections.md | 125 +++++++++ docs/zh-rCN/user/desktop.md | 147 +++++++++++ docs/zh-rCN/user/discovery.md | 114 ++++++++ docs/zh-rCN/user/firmware.md | 114 ++++++++ docs/zh-rCN/user/map-and-waypoints.md | 116 +++++++++ docs/zh-rCN/user/messages-and-channels.md | 159 +++++++++++ docs/zh-rCN/user/mqtt.md | 137 ++++++++++ docs/zh-rCN/user/node-metrics.md | 130 +++++++++ docs/zh-rCN/user/nodes.md | 152 +++++++++++ docs/zh-rCN/user/onboarding.md | 99 +++++++ docs/zh-rCN/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/zh-rCN/user/settings-radio-user.md | 173 ++++++++++++ docs/zh-rCN/user/signal-meter.md | 81 ++++++ docs/zh-rCN/user/tak.md | 126 +++++++++ docs/zh-rCN/user/telemetry-and-sensors.md | 118 +++++++++ docs/zh-rCN/user/translate.md | 97 +++++++ docs/zh-rCN/user/units-and-locale.md | 118 +++++++++ docs/zh-rTW/index.md | 30 +++ docs/zh-rTW/user/connections.md | 125 +++++++++ docs/zh-rTW/user/desktop.md | 147 +++++++++++ docs/zh-rTW/user/discovery.md | 114 ++++++++ docs/zh-rTW/user/firmware.md | 114 ++++++++ docs/zh-rTW/user/map-and-waypoints.md | 116 +++++++++ docs/zh-rTW/user/messages-and-channels.md | 159 +++++++++++ docs/zh-rTW/user/mqtt.md | 137 ++++++++++ docs/zh-rTW/user/node-metrics.md | 130 +++++++++ docs/zh-rTW/user/nodes.md | 152 +++++++++++ docs/zh-rTW/user/onboarding.md | 237 +++++++++++++++++ docs/zh-rTW/user/settings-module-admin.md | 246 ++++++++++++++++++ docs/zh-rTW/user/settings-radio-user.md | 173 ++++++++++++ docs/zh-rTW/user/signal-meter.md | 225 ++++++++++++++++ docs/zh-rTW/user/tak.md | 126 +++++++++ docs/zh-rTW/user/telemetry-and-sensors.md | 118 +++++++++ docs/zh-rTW/user/translate.md | 97 +++++++ docs/zh-rTW/user/units-and-locale.md | 118 +++++++++ 743 files changed, 89519 insertions(+), 1 deletion(-) create mode 100644 docs/ar-rSA/index.md create mode 100644 docs/ar-rSA/user/connections.md create mode 100644 docs/ar-rSA/user/desktop.md create mode 100644 docs/ar-rSA/user/discovery.md create mode 100644 docs/ar-rSA/user/firmware.md create mode 100644 docs/ar-rSA/user/map-and-waypoints.md create mode 100644 docs/ar-rSA/user/messages-and-channels.md create mode 100644 docs/ar-rSA/user/mqtt.md create mode 100644 docs/ar-rSA/user/node-metrics.md create mode 100644 docs/ar-rSA/user/nodes.md create mode 100644 docs/ar-rSA/user/onboarding.md create mode 100644 docs/ar-rSA/user/settings-module-admin.md create mode 100644 docs/ar-rSA/user/settings-radio-user.md create mode 100644 docs/ar-rSA/user/signal-meter.md create mode 100644 docs/ar-rSA/user/tak.md create mode 100644 docs/ar-rSA/user/telemetry-and-sensors.md create mode 100644 docs/ar-rSA/user/translate.md create mode 100644 docs/ar-rSA/user/units-and-locale.md create mode 100644 docs/be-rBY/index.md create mode 100644 docs/be-rBY/user/connections.md create mode 100644 docs/be-rBY/user/desktop.md create mode 100644 docs/be-rBY/user/discovery.md create mode 100644 docs/be-rBY/user/firmware.md create mode 100644 docs/be-rBY/user/map-and-waypoints.md create mode 100644 docs/be-rBY/user/messages-and-channels.md create mode 100644 docs/be-rBY/user/mqtt.md create mode 100644 docs/be-rBY/user/node-metrics.md create mode 100644 docs/be-rBY/user/nodes.md create mode 100644 docs/be-rBY/user/onboarding.md create mode 100644 docs/be-rBY/user/settings-module-admin.md create mode 100644 docs/be-rBY/user/settings-radio-user.md create mode 100644 docs/be-rBY/user/signal-meter.md create mode 100644 docs/be-rBY/user/tak.md create mode 100644 docs/be-rBY/user/telemetry-and-sensors.md create mode 100644 docs/be-rBY/user/translate.md create mode 100644 docs/be-rBY/user/units-and-locale.md create mode 100644 docs/bg-rBG/index.md create mode 100644 docs/bg-rBG/user/connections.md create mode 100644 docs/bg-rBG/user/desktop.md create mode 100644 docs/bg-rBG/user/discovery.md create mode 100644 docs/bg-rBG/user/firmware.md create mode 100644 docs/bg-rBG/user/map-and-waypoints.md create mode 100644 docs/bg-rBG/user/messages-and-channels.md create mode 100644 docs/bg-rBG/user/mqtt.md create mode 100644 docs/bg-rBG/user/node-metrics.md create mode 100644 docs/bg-rBG/user/nodes.md create mode 100644 docs/bg-rBG/user/onboarding.md create mode 100644 docs/bg-rBG/user/settings-module-admin.md create mode 100644 docs/bg-rBG/user/settings-radio-user.md create mode 100644 docs/bg-rBG/user/signal-meter.md create mode 100644 docs/bg-rBG/user/tak.md create mode 100644 docs/bg-rBG/user/telemetry-and-sensors.md create mode 100644 docs/bg-rBG/user/translate.md create mode 100644 docs/bg-rBG/user/units-and-locale.md create mode 100644 docs/ca-rES/index.md create mode 100644 docs/ca-rES/user/connections.md create mode 100644 docs/ca-rES/user/desktop.md create mode 100644 docs/ca-rES/user/discovery.md create mode 100644 docs/ca-rES/user/firmware.md create mode 100644 docs/ca-rES/user/map-and-waypoints.md create mode 100644 docs/ca-rES/user/messages-and-channels.md create mode 100644 docs/ca-rES/user/mqtt.md create mode 100644 docs/ca-rES/user/node-metrics.md create mode 100644 docs/ca-rES/user/nodes.md create mode 100644 docs/ca-rES/user/onboarding.md create mode 100644 docs/ca-rES/user/settings-module-admin.md create mode 100644 docs/ca-rES/user/settings-radio-user.md create mode 100644 docs/ca-rES/user/signal-meter.md create mode 100644 docs/ca-rES/user/tak.md create mode 100644 docs/ca-rES/user/telemetry-and-sensors.md create mode 100644 docs/ca-rES/user/translate.md create mode 100644 docs/ca-rES/user/units-and-locale.md create mode 100644 docs/cs-rCZ/index.md create mode 100644 docs/cs-rCZ/user/connections.md create mode 100644 docs/cs-rCZ/user/desktop.md create mode 100644 docs/cs-rCZ/user/discovery.md create mode 100644 docs/cs-rCZ/user/firmware.md create mode 100644 docs/cs-rCZ/user/map-and-waypoints.md create mode 100644 docs/cs-rCZ/user/messages-and-channels.md create mode 100644 docs/cs-rCZ/user/mqtt.md create mode 100644 docs/cs-rCZ/user/node-metrics.md create mode 100644 docs/cs-rCZ/user/nodes.md create mode 100644 docs/cs-rCZ/user/onboarding.md create mode 100644 docs/cs-rCZ/user/settings-module-admin.md create mode 100644 docs/cs-rCZ/user/settings-radio-user.md create mode 100644 docs/cs-rCZ/user/signal-meter.md create mode 100644 docs/cs-rCZ/user/tak.md create mode 100644 docs/cs-rCZ/user/telemetry-and-sensors.md create mode 100644 docs/cs-rCZ/user/translate.md create mode 100644 docs/cs-rCZ/user/units-and-locale.md create mode 100644 docs/de-rDE/index.md create mode 100644 docs/de-rDE/user/connections.md create mode 100644 docs/de-rDE/user/desktop.md create mode 100644 docs/de-rDE/user/discovery.md create mode 100644 docs/de-rDE/user/firmware.md create mode 100644 docs/de-rDE/user/map-and-waypoints.md create mode 100644 docs/de-rDE/user/messages-and-channels.md create mode 100644 docs/de-rDE/user/mqtt.md create mode 100644 docs/de-rDE/user/node-metrics.md create mode 100644 docs/de-rDE/user/nodes.md create mode 100644 docs/de-rDE/user/onboarding.md create mode 100644 docs/de-rDE/user/settings-module-admin.md create mode 100644 docs/de-rDE/user/settings-radio-user.md create mode 100644 docs/de-rDE/user/signal-meter.md create mode 100644 docs/de-rDE/user/tak.md create mode 100644 docs/de-rDE/user/telemetry-and-sensors.md create mode 100644 docs/de-rDE/user/translate.md create mode 100644 docs/de-rDE/user/units-and-locale.md create mode 100644 docs/el-rGR/index.md create mode 100644 docs/el-rGR/user/connections.md create mode 100644 docs/el-rGR/user/desktop.md create mode 100644 docs/el-rGR/user/discovery.md create mode 100644 docs/el-rGR/user/firmware.md create mode 100644 docs/el-rGR/user/map-and-waypoints.md create mode 100644 docs/el-rGR/user/messages-and-channels.md create mode 100644 docs/el-rGR/user/mqtt.md create mode 100644 docs/el-rGR/user/node-metrics.md create mode 100644 docs/el-rGR/user/nodes.md create mode 100644 docs/el-rGR/user/onboarding.md create mode 100644 docs/el-rGR/user/settings-module-admin.md create mode 100644 docs/el-rGR/user/settings-radio-user.md create mode 100644 docs/el-rGR/user/signal-meter.md create mode 100644 docs/el-rGR/user/tak.md create mode 100644 docs/el-rGR/user/telemetry-and-sensors.md create mode 100644 docs/el-rGR/user/translate.md create mode 100644 docs/el-rGR/user/units-and-locale.md create mode 100644 docs/es-rES/index.md create mode 100644 docs/es-rES/user/connections.md create mode 100644 docs/es-rES/user/desktop.md create mode 100644 docs/es-rES/user/discovery.md create mode 100644 docs/es-rES/user/firmware.md create mode 100644 docs/es-rES/user/map-and-waypoints.md create mode 100644 docs/es-rES/user/messages-and-channels.md create mode 100644 docs/es-rES/user/mqtt.md create mode 100644 docs/es-rES/user/node-metrics.md create mode 100644 docs/es-rES/user/nodes.md create mode 100644 docs/es-rES/user/onboarding.md create mode 100644 docs/es-rES/user/settings-module-admin.md create mode 100644 docs/es-rES/user/settings-radio-user.md create mode 100644 docs/es-rES/user/signal-meter.md create mode 100644 docs/es-rES/user/tak.md create mode 100644 docs/es-rES/user/telemetry-and-sensors.md create mode 100644 docs/es-rES/user/translate.md create mode 100644 docs/es-rES/user/units-and-locale.md create mode 100644 docs/et-rEE/index.md create mode 100644 docs/et-rEE/user/connections.md create mode 100644 docs/et-rEE/user/desktop.md create mode 100644 docs/et-rEE/user/discovery.md create mode 100644 docs/et-rEE/user/firmware.md create mode 100644 docs/et-rEE/user/map-and-waypoints.md create mode 100644 docs/et-rEE/user/messages-and-channels.md create mode 100644 docs/et-rEE/user/mqtt.md create mode 100644 docs/et-rEE/user/node-metrics.md create mode 100644 docs/et-rEE/user/nodes.md create mode 100644 docs/et-rEE/user/onboarding.md create mode 100644 docs/et-rEE/user/settings-module-admin.md create mode 100644 docs/et-rEE/user/settings-radio-user.md create mode 100644 docs/et-rEE/user/signal-meter.md create mode 100644 docs/et-rEE/user/tak.md create mode 100644 docs/et-rEE/user/telemetry-and-sensors.md create mode 100644 docs/et-rEE/user/translate.md create mode 100644 docs/et-rEE/user/units-and-locale.md create mode 100644 docs/fi-rFI/index.md create mode 100644 docs/fi-rFI/user/connections.md create mode 100644 docs/fi-rFI/user/desktop.md create mode 100644 docs/fi-rFI/user/discovery.md create mode 100644 docs/fi-rFI/user/firmware.md create mode 100644 docs/fi-rFI/user/map-and-waypoints.md create mode 100644 docs/fi-rFI/user/messages-and-channels.md create mode 100644 docs/fi-rFI/user/mqtt.md create mode 100644 docs/fi-rFI/user/node-metrics.md create mode 100644 docs/fi-rFI/user/nodes.md create mode 100644 docs/fi-rFI/user/onboarding.md create mode 100644 docs/fi-rFI/user/settings-module-admin.md create mode 100644 docs/fi-rFI/user/settings-radio-user.md create mode 100644 docs/fi-rFI/user/signal-meter.md create mode 100644 docs/fi-rFI/user/tak.md create mode 100644 docs/fi-rFI/user/telemetry-and-sensors.md create mode 100644 docs/fi-rFI/user/translate.md create mode 100644 docs/fi-rFI/user/units-and-locale.md create mode 100644 docs/fr-rFR/index.md create mode 100644 docs/fr-rFR/user/connections.md create mode 100644 docs/fr-rFR/user/desktop.md create mode 100644 docs/fr-rFR/user/discovery.md create mode 100644 docs/fr-rFR/user/firmware.md create mode 100644 docs/fr-rFR/user/map-and-waypoints.md create mode 100644 docs/fr-rFR/user/messages-and-channels.md create mode 100644 docs/fr-rFR/user/mqtt.md create mode 100644 docs/fr-rFR/user/node-metrics.md create mode 100644 docs/fr-rFR/user/nodes.md create mode 100644 docs/fr-rFR/user/onboarding.md create mode 100644 docs/fr-rFR/user/settings-module-admin.md create mode 100644 docs/fr-rFR/user/settings-radio-user.md create mode 100644 docs/fr-rFR/user/signal-meter.md create mode 100644 docs/fr-rFR/user/tak.md create mode 100644 docs/fr-rFR/user/telemetry-and-sensors.md create mode 100644 docs/fr-rFR/user/translate.md create mode 100644 docs/fr-rFR/user/units-and-locale.md create mode 100644 docs/ga-rIE/index.md create mode 100644 docs/ga-rIE/user/connections.md create mode 100644 docs/ga-rIE/user/desktop.md create mode 100644 docs/ga-rIE/user/discovery.md create mode 100644 docs/ga-rIE/user/firmware.md create mode 100644 docs/ga-rIE/user/map-and-waypoints.md create mode 100644 docs/ga-rIE/user/messages-and-channels.md create mode 100644 docs/ga-rIE/user/mqtt.md create mode 100644 docs/ga-rIE/user/node-metrics.md create mode 100644 docs/ga-rIE/user/nodes.md create mode 100644 docs/ga-rIE/user/onboarding.md create mode 100644 docs/ga-rIE/user/settings-module-admin.md create mode 100644 docs/ga-rIE/user/settings-radio-user.md create mode 100644 docs/ga-rIE/user/signal-meter.md create mode 100644 docs/ga-rIE/user/tak.md create mode 100644 docs/ga-rIE/user/telemetry-and-sensors.md create mode 100644 docs/ga-rIE/user/translate.md create mode 100644 docs/ga-rIE/user/units-and-locale.md create mode 100644 docs/gl-rES/index.md create mode 100644 docs/gl-rES/user/connections.md create mode 100644 docs/gl-rES/user/desktop.md create mode 100644 docs/gl-rES/user/discovery.md create mode 100644 docs/gl-rES/user/firmware.md create mode 100644 docs/gl-rES/user/map-and-waypoints.md create mode 100644 docs/gl-rES/user/messages-and-channels.md create mode 100644 docs/gl-rES/user/mqtt.md create mode 100644 docs/gl-rES/user/node-metrics.md create mode 100644 docs/gl-rES/user/nodes.md create mode 100644 docs/gl-rES/user/onboarding.md create mode 100644 docs/gl-rES/user/settings-module-admin.md create mode 100644 docs/gl-rES/user/settings-radio-user.md create mode 100644 docs/gl-rES/user/signal-meter.md create mode 100644 docs/gl-rES/user/tak.md create mode 100644 docs/gl-rES/user/telemetry-and-sensors.md create mode 100644 docs/gl-rES/user/translate.md create mode 100644 docs/gl-rES/user/units-and-locale.md create mode 100644 docs/hr-rHR/index.md create mode 100644 docs/hr-rHR/user/connections.md create mode 100644 docs/hr-rHR/user/desktop.md create mode 100644 docs/hr-rHR/user/discovery.md create mode 100644 docs/hr-rHR/user/firmware.md create mode 100644 docs/hr-rHR/user/map-and-waypoints.md create mode 100644 docs/hr-rHR/user/messages-and-channels.md create mode 100644 docs/hr-rHR/user/mqtt.md create mode 100644 docs/hr-rHR/user/node-metrics.md create mode 100644 docs/hr-rHR/user/nodes.md create mode 100644 docs/hr-rHR/user/onboarding.md create mode 100644 docs/hr-rHR/user/settings-module-admin.md create mode 100644 docs/hr-rHR/user/settings-radio-user.md create mode 100644 docs/hr-rHR/user/signal-meter.md create mode 100644 docs/hr-rHR/user/tak.md create mode 100644 docs/hr-rHR/user/telemetry-and-sensors.md create mode 100644 docs/hr-rHR/user/translate.md create mode 100644 docs/hr-rHR/user/units-and-locale.md create mode 100644 docs/ht-rHT/index.md create mode 100644 docs/ht-rHT/user/connections.md create mode 100644 docs/ht-rHT/user/desktop.md create mode 100644 docs/ht-rHT/user/discovery.md create mode 100644 docs/ht-rHT/user/firmware.md create mode 100644 docs/ht-rHT/user/map-and-waypoints.md create mode 100644 docs/ht-rHT/user/messages-and-channels.md create mode 100644 docs/ht-rHT/user/mqtt.md create mode 100644 docs/ht-rHT/user/node-metrics.md create mode 100644 docs/ht-rHT/user/nodes.md create mode 100644 docs/ht-rHT/user/onboarding.md create mode 100644 docs/ht-rHT/user/settings-module-admin.md create mode 100644 docs/ht-rHT/user/settings-radio-user.md create mode 100644 docs/ht-rHT/user/signal-meter.md create mode 100644 docs/ht-rHT/user/tak.md create mode 100644 docs/ht-rHT/user/telemetry-and-sensors.md create mode 100644 docs/ht-rHT/user/translate.md create mode 100644 docs/ht-rHT/user/units-and-locale.md create mode 100644 docs/hu-rHU/index.md create mode 100644 docs/hu-rHU/user/connections.md create mode 100644 docs/hu-rHU/user/desktop.md create mode 100644 docs/hu-rHU/user/discovery.md create mode 100644 docs/hu-rHU/user/firmware.md create mode 100644 docs/hu-rHU/user/map-and-waypoints.md create mode 100644 docs/hu-rHU/user/messages-and-channels.md create mode 100644 docs/hu-rHU/user/mqtt.md create mode 100644 docs/hu-rHU/user/node-metrics.md create mode 100644 docs/hu-rHU/user/nodes.md create mode 100644 docs/hu-rHU/user/onboarding.md create mode 100644 docs/hu-rHU/user/settings-module-admin.md create mode 100644 docs/hu-rHU/user/settings-radio-user.md create mode 100644 docs/hu-rHU/user/signal-meter.md create mode 100644 docs/hu-rHU/user/tak.md create mode 100644 docs/hu-rHU/user/telemetry-and-sensors.md create mode 100644 docs/hu-rHU/user/translate.md create mode 100644 docs/hu-rHU/user/units-and-locale.md create mode 100644 docs/is-rIS/index.md create mode 100644 docs/is-rIS/user/connections.md create mode 100644 docs/is-rIS/user/desktop.md create mode 100644 docs/is-rIS/user/discovery.md create mode 100644 docs/is-rIS/user/firmware.md create mode 100644 docs/is-rIS/user/map-and-waypoints.md create mode 100644 docs/is-rIS/user/messages-and-channels.md create mode 100644 docs/is-rIS/user/mqtt.md create mode 100644 docs/is-rIS/user/node-metrics.md create mode 100644 docs/is-rIS/user/nodes.md create mode 100644 docs/is-rIS/user/onboarding.md create mode 100644 docs/is-rIS/user/settings-module-admin.md create mode 100644 docs/is-rIS/user/settings-radio-user.md create mode 100644 docs/is-rIS/user/signal-meter.md create mode 100644 docs/is-rIS/user/tak.md create mode 100644 docs/is-rIS/user/telemetry-and-sensors.md create mode 100644 docs/is-rIS/user/translate.md create mode 100644 docs/is-rIS/user/units-and-locale.md create mode 100644 docs/it-rIT/index.md create mode 100644 docs/it-rIT/user/connections.md create mode 100644 docs/it-rIT/user/desktop.md create mode 100644 docs/it-rIT/user/discovery.md create mode 100644 docs/it-rIT/user/firmware.md create mode 100644 docs/it-rIT/user/map-and-waypoints.md create mode 100644 docs/it-rIT/user/messages-and-channels.md create mode 100644 docs/it-rIT/user/mqtt.md create mode 100644 docs/it-rIT/user/node-metrics.md create mode 100644 docs/it-rIT/user/nodes.md create mode 100644 docs/it-rIT/user/onboarding.md create mode 100644 docs/it-rIT/user/settings-module-admin.md create mode 100644 docs/it-rIT/user/settings-radio-user.md create mode 100644 docs/it-rIT/user/signal-meter.md create mode 100644 docs/it-rIT/user/tak.md create mode 100644 docs/it-rIT/user/telemetry-and-sensors.md create mode 100644 docs/it-rIT/user/translate.md create mode 100644 docs/it-rIT/user/units-and-locale.md create mode 100644 docs/iw-rIL/index.md create mode 100644 docs/iw-rIL/user/connections.md create mode 100644 docs/iw-rIL/user/desktop.md create mode 100644 docs/iw-rIL/user/discovery.md create mode 100644 docs/iw-rIL/user/firmware.md create mode 100644 docs/iw-rIL/user/map-and-waypoints.md create mode 100644 docs/iw-rIL/user/messages-and-channels.md create mode 100644 docs/iw-rIL/user/mqtt.md create mode 100644 docs/iw-rIL/user/node-metrics.md create mode 100644 docs/iw-rIL/user/nodes.md create mode 100644 docs/iw-rIL/user/onboarding.md create mode 100644 docs/iw-rIL/user/settings-module-admin.md create mode 100644 docs/iw-rIL/user/settings-radio-user.md create mode 100644 docs/iw-rIL/user/signal-meter.md create mode 100644 docs/iw-rIL/user/tak.md create mode 100644 docs/iw-rIL/user/telemetry-and-sensors.md create mode 100644 docs/iw-rIL/user/translate.md create mode 100644 docs/iw-rIL/user/units-and-locale.md create mode 100644 docs/ja-rJP/index.md create mode 100644 docs/ja-rJP/user/connections.md create mode 100644 docs/ja-rJP/user/desktop.md create mode 100644 docs/ja-rJP/user/discovery.md create mode 100644 docs/ja-rJP/user/firmware.md create mode 100644 docs/ja-rJP/user/map-and-waypoints.md create mode 100644 docs/ja-rJP/user/messages-and-channels.md create mode 100644 docs/ja-rJP/user/mqtt.md create mode 100644 docs/ja-rJP/user/node-metrics.md create mode 100644 docs/ja-rJP/user/nodes.md create mode 100644 docs/ja-rJP/user/onboarding.md create mode 100644 docs/ja-rJP/user/settings-module-admin.md create mode 100644 docs/ja-rJP/user/settings-radio-user.md create mode 100644 docs/ja-rJP/user/signal-meter.md create mode 100644 docs/ja-rJP/user/tak.md create mode 100644 docs/ja-rJP/user/telemetry-and-sensors.md create mode 100644 docs/ja-rJP/user/translate.md create mode 100644 docs/ja-rJP/user/units-and-locale.md create mode 100644 docs/ko-rKR/index.md create mode 100644 docs/ko-rKR/user/connections.md create mode 100644 docs/ko-rKR/user/desktop.md create mode 100644 docs/ko-rKR/user/discovery.md create mode 100644 docs/ko-rKR/user/firmware.md create mode 100644 docs/ko-rKR/user/map-and-waypoints.md create mode 100644 docs/ko-rKR/user/messages-and-channels.md create mode 100644 docs/ko-rKR/user/mqtt.md create mode 100644 docs/ko-rKR/user/node-metrics.md create mode 100644 docs/ko-rKR/user/nodes.md create mode 100644 docs/ko-rKR/user/onboarding.md create mode 100644 docs/ko-rKR/user/settings-module-admin.md create mode 100644 docs/ko-rKR/user/settings-radio-user.md create mode 100644 docs/ko-rKR/user/signal-meter.md create mode 100644 docs/ko-rKR/user/tak.md create mode 100644 docs/ko-rKR/user/telemetry-and-sensors.md create mode 100644 docs/ko-rKR/user/translate.md create mode 100644 docs/ko-rKR/user/units-and-locale.md create mode 100644 docs/lt-rLT/index.md create mode 100644 docs/lt-rLT/user/connections.md create mode 100644 docs/lt-rLT/user/desktop.md create mode 100644 docs/lt-rLT/user/discovery.md create mode 100644 docs/lt-rLT/user/firmware.md create mode 100644 docs/lt-rLT/user/map-and-waypoints.md create mode 100644 docs/lt-rLT/user/messages-and-channels.md create mode 100644 docs/lt-rLT/user/mqtt.md create mode 100644 docs/lt-rLT/user/node-metrics.md create mode 100644 docs/lt-rLT/user/nodes.md create mode 100644 docs/lt-rLT/user/onboarding.md create mode 100644 docs/lt-rLT/user/settings-module-admin.md create mode 100644 docs/lt-rLT/user/settings-radio-user.md create mode 100644 docs/lt-rLT/user/signal-meter.md create mode 100644 docs/lt-rLT/user/tak.md create mode 100644 docs/lt-rLT/user/telemetry-and-sensors.md create mode 100644 docs/lt-rLT/user/translate.md create mode 100644 docs/lt-rLT/user/units-and-locale.md create mode 100644 docs/nl-rNL/index.md create mode 100644 docs/nl-rNL/user/connections.md create mode 100644 docs/nl-rNL/user/desktop.md create mode 100644 docs/nl-rNL/user/discovery.md create mode 100644 docs/nl-rNL/user/firmware.md create mode 100644 docs/nl-rNL/user/map-and-waypoints.md create mode 100644 docs/nl-rNL/user/messages-and-channels.md create mode 100644 docs/nl-rNL/user/mqtt.md create mode 100644 docs/nl-rNL/user/node-metrics.md create mode 100644 docs/nl-rNL/user/nodes.md create mode 100644 docs/nl-rNL/user/onboarding.md create mode 100644 docs/nl-rNL/user/settings-module-admin.md create mode 100644 docs/nl-rNL/user/settings-radio-user.md create mode 100644 docs/nl-rNL/user/signal-meter.md create mode 100644 docs/nl-rNL/user/tak.md create mode 100644 docs/nl-rNL/user/telemetry-and-sensors.md create mode 100644 docs/nl-rNL/user/translate.md create mode 100644 docs/nl-rNL/user/units-and-locale.md create mode 100644 docs/no-rNO/index.md create mode 100644 docs/no-rNO/user/connections.md create mode 100644 docs/no-rNO/user/desktop.md create mode 100644 docs/no-rNO/user/discovery.md create mode 100644 docs/no-rNO/user/firmware.md create mode 100644 docs/no-rNO/user/map-and-waypoints.md create mode 100644 docs/no-rNO/user/messages-and-channels.md create mode 100644 docs/no-rNO/user/mqtt.md create mode 100644 docs/no-rNO/user/node-metrics.md create mode 100644 docs/no-rNO/user/nodes.md create mode 100644 docs/no-rNO/user/onboarding.md create mode 100644 docs/no-rNO/user/settings-module-admin.md create mode 100644 docs/no-rNO/user/settings-radio-user.md create mode 100644 docs/no-rNO/user/signal-meter.md create mode 100644 docs/no-rNO/user/tak.md create mode 100644 docs/no-rNO/user/telemetry-and-sensors.md create mode 100644 docs/no-rNO/user/translate.md create mode 100644 docs/no-rNO/user/units-and-locale.md create mode 100644 docs/pl-rPL/index.md create mode 100644 docs/pl-rPL/user/connections.md create mode 100644 docs/pl-rPL/user/desktop.md create mode 100644 docs/pl-rPL/user/discovery.md create mode 100644 docs/pl-rPL/user/firmware.md create mode 100644 docs/pl-rPL/user/map-and-waypoints.md create mode 100644 docs/pl-rPL/user/messages-and-channels.md create mode 100644 docs/pl-rPL/user/mqtt.md create mode 100644 docs/pl-rPL/user/node-metrics.md create mode 100644 docs/pl-rPL/user/nodes.md create mode 100644 docs/pl-rPL/user/onboarding.md create mode 100644 docs/pl-rPL/user/settings-module-admin.md create mode 100644 docs/pl-rPL/user/settings-radio-user.md create mode 100644 docs/pl-rPL/user/signal-meter.md create mode 100644 docs/pl-rPL/user/tak.md create mode 100644 docs/pl-rPL/user/telemetry-and-sensors.md create mode 100644 docs/pl-rPL/user/translate.md create mode 100644 docs/pl-rPL/user/units-and-locale.md create mode 100644 docs/pt-rBR/index.md create mode 100644 docs/pt-rBR/user/connections.md create mode 100644 docs/pt-rBR/user/desktop.md create mode 100644 docs/pt-rBR/user/discovery.md create mode 100644 docs/pt-rBR/user/firmware.md create mode 100644 docs/pt-rBR/user/map-and-waypoints.md create mode 100644 docs/pt-rBR/user/messages-and-channels.md create mode 100644 docs/pt-rBR/user/mqtt.md create mode 100644 docs/pt-rBR/user/node-metrics.md create mode 100644 docs/pt-rBR/user/nodes.md create mode 100644 docs/pt-rBR/user/onboarding.md create mode 100644 docs/pt-rBR/user/settings-module-admin.md create mode 100644 docs/pt-rBR/user/settings-radio-user.md create mode 100644 docs/pt-rBR/user/signal-meter.md create mode 100644 docs/pt-rBR/user/tak.md create mode 100644 docs/pt-rBR/user/telemetry-and-sensors.md create mode 100644 docs/pt-rBR/user/translate.md create mode 100644 docs/pt-rBR/user/units-and-locale.md create mode 100644 docs/pt-rPT/index.md create mode 100644 docs/pt-rPT/user/connections.md create mode 100644 docs/pt-rPT/user/desktop.md create mode 100644 docs/pt-rPT/user/discovery.md create mode 100644 docs/pt-rPT/user/firmware.md create mode 100644 docs/pt-rPT/user/map-and-waypoints.md create mode 100644 docs/pt-rPT/user/messages-and-channels.md create mode 100644 docs/pt-rPT/user/mqtt.md create mode 100644 docs/pt-rPT/user/node-metrics.md create mode 100644 docs/pt-rPT/user/nodes.md create mode 100644 docs/pt-rPT/user/onboarding.md create mode 100644 docs/pt-rPT/user/settings-module-admin.md create mode 100644 docs/pt-rPT/user/settings-radio-user.md create mode 100644 docs/pt-rPT/user/signal-meter.md create mode 100644 docs/pt-rPT/user/tak.md create mode 100644 docs/pt-rPT/user/telemetry-and-sensors.md create mode 100644 docs/pt-rPT/user/translate.md create mode 100644 docs/pt-rPT/user/units-and-locale.md create mode 100644 docs/ro-rRO/index.md create mode 100644 docs/ro-rRO/user/connections.md create mode 100644 docs/ro-rRO/user/desktop.md create mode 100644 docs/ro-rRO/user/discovery.md create mode 100644 docs/ro-rRO/user/firmware.md create mode 100644 docs/ro-rRO/user/map-and-waypoints.md create mode 100644 docs/ro-rRO/user/messages-and-channels.md create mode 100644 docs/ro-rRO/user/mqtt.md create mode 100644 docs/ro-rRO/user/node-metrics.md create mode 100644 docs/ro-rRO/user/nodes.md create mode 100644 docs/ro-rRO/user/onboarding.md create mode 100644 docs/ro-rRO/user/settings-module-admin.md create mode 100644 docs/ro-rRO/user/settings-radio-user.md create mode 100644 docs/ro-rRO/user/signal-meter.md create mode 100644 docs/ro-rRO/user/tak.md create mode 100644 docs/ro-rRO/user/telemetry-and-sensors.md create mode 100644 docs/ro-rRO/user/translate.md create mode 100644 docs/ro-rRO/user/units-and-locale.md create mode 100644 docs/ru-rRU/index.md create mode 100644 docs/ru-rRU/user/connections.md create mode 100644 docs/ru-rRU/user/desktop.md create mode 100644 docs/ru-rRU/user/discovery.md create mode 100644 docs/ru-rRU/user/firmware.md create mode 100644 docs/ru-rRU/user/map-and-waypoints.md create mode 100644 docs/ru-rRU/user/messages-and-channels.md create mode 100644 docs/ru-rRU/user/mqtt.md create mode 100644 docs/ru-rRU/user/node-metrics.md create mode 100644 docs/ru-rRU/user/nodes.md create mode 100644 docs/ru-rRU/user/onboarding.md create mode 100644 docs/ru-rRU/user/settings-module-admin.md create mode 100644 docs/ru-rRU/user/settings-radio-user.md create mode 100644 docs/ru-rRU/user/signal-meter.md create mode 100644 docs/ru-rRU/user/tak.md create mode 100644 docs/ru-rRU/user/telemetry-and-sensors.md create mode 100644 docs/ru-rRU/user/translate.md create mode 100644 docs/ru-rRU/user/units-and-locale.md create mode 100644 docs/sk-rSK/index.md create mode 100644 docs/sk-rSK/user/connections.md create mode 100644 docs/sk-rSK/user/desktop.md create mode 100644 docs/sk-rSK/user/discovery.md create mode 100644 docs/sk-rSK/user/firmware.md create mode 100644 docs/sk-rSK/user/map-and-waypoints.md create mode 100644 docs/sk-rSK/user/messages-and-channels.md create mode 100644 docs/sk-rSK/user/mqtt.md create mode 100644 docs/sk-rSK/user/node-metrics.md create mode 100644 docs/sk-rSK/user/nodes.md create mode 100644 docs/sk-rSK/user/onboarding.md create mode 100644 docs/sk-rSK/user/settings-module-admin.md create mode 100644 docs/sk-rSK/user/settings-radio-user.md create mode 100644 docs/sk-rSK/user/signal-meter.md create mode 100644 docs/sk-rSK/user/tak.md create mode 100644 docs/sk-rSK/user/telemetry-and-sensors.md create mode 100644 docs/sk-rSK/user/translate.md create mode 100644 docs/sk-rSK/user/units-and-locale.md create mode 100644 docs/sl-rSI/index.md create mode 100644 docs/sl-rSI/user/connections.md create mode 100644 docs/sl-rSI/user/desktop.md create mode 100644 docs/sl-rSI/user/discovery.md create mode 100644 docs/sl-rSI/user/firmware.md create mode 100644 docs/sl-rSI/user/map-and-waypoints.md create mode 100644 docs/sl-rSI/user/messages-and-channels.md create mode 100644 docs/sl-rSI/user/mqtt.md create mode 100644 docs/sl-rSI/user/node-metrics.md create mode 100644 docs/sl-rSI/user/nodes.md create mode 100644 docs/sl-rSI/user/onboarding.md create mode 100644 docs/sl-rSI/user/settings-module-admin.md create mode 100644 docs/sl-rSI/user/settings-radio-user.md create mode 100644 docs/sl-rSI/user/signal-meter.md create mode 100644 docs/sl-rSI/user/tak.md create mode 100644 docs/sl-rSI/user/telemetry-and-sensors.md create mode 100644 docs/sl-rSI/user/translate.md create mode 100644 docs/sl-rSI/user/units-and-locale.md create mode 100644 docs/sq-rAL/index.md create mode 100644 docs/sq-rAL/user/connections.md create mode 100644 docs/sq-rAL/user/desktop.md create mode 100644 docs/sq-rAL/user/discovery.md create mode 100644 docs/sq-rAL/user/firmware.md create mode 100644 docs/sq-rAL/user/map-and-waypoints.md create mode 100644 docs/sq-rAL/user/messages-and-channels.md create mode 100644 docs/sq-rAL/user/mqtt.md create mode 100644 docs/sq-rAL/user/node-metrics.md create mode 100644 docs/sq-rAL/user/nodes.md create mode 100644 docs/sq-rAL/user/onboarding.md create mode 100644 docs/sq-rAL/user/settings-module-admin.md create mode 100644 docs/sq-rAL/user/settings-radio-user.md create mode 100644 docs/sq-rAL/user/signal-meter.md create mode 100644 docs/sq-rAL/user/tak.md create mode 100644 docs/sq-rAL/user/telemetry-and-sensors.md create mode 100644 docs/sq-rAL/user/translate.md create mode 100644 docs/sq-rAL/user/units-and-locale.md create mode 100644 docs/sr-rLatn/index.md create mode 100644 docs/sr-rLatn/user/connections.md create mode 100644 docs/sr-rLatn/user/desktop.md create mode 100644 docs/sr-rLatn/user/discovery.md create mode 100644 docs/sr-rLatn/user/firmware.md create mode 100644 docs/sr-rLatn/user/map-and-waypoints.md create mode 100644 docs/sr-rLatn/user/messages-and-channels.md create mode 100644 docs/sr-rLatn/user/mqtt.md create mode 100644 docs/sr-rLatn/user/node-metrics.md create mode 100644 docs/sr-rLatn/user/nodes.md create mode 100644 docs/sr-rLatn/user/onboarding.md create mode 100644 docs/sr-rLatn/user/settings-module-admin.md create mode 100644 docs/sr-rLatn/user/settings-radio-user.md create mode 100644 docs/sr-rLatn/user/signal-meter.md create mode 100644 docs/sr-rLatn/user/tak.md create mode 100644 docs/sr-rLatn/user/telemetry-and-sensors.md create mode 100644 docs/sr-rLatn/user/translate.md create mode 100644 docs/sr-rLatn/user/units-and-locale.md create mode 100644 docs/srp/index.md create mode 100644 docs/srp/user/connections.md create mode 100644 docs/srp/user/desktop.md create mode 100644 docs/srp/user/discovery.md create mode 100644 docs/srp/user/firmware.md create mode 100644 docs/srp/user/map-and-waypoints.md create mode 100644 docs/srp/user/messages-and-channels.md create mode 100644 docs/srp/user/mqtt.md create mode 100644 docs/srp/user/node-metrics.md create mode 100644 docs/srp/user/nodes.md create mode 100644 docs/srp/user/onboarding.md create mode 100644 docs/srp/user/settings-module-admin.md create mode 100644 docs/srp/user/settings-radio-user.md create mode 100644 docs/srp/user/signal-meter.md create mode 100644 docs/srp/user/tak.md create mode 100644 docs/srp/user/telemetry-and-sensors.md create mode 100644 docs/srp/user/translate.md create mode 100644 docs/srp/user/units-and-locale.md create mode 100644 docs/sv-rSE/index.md create mode 100644 docs/sv-rSE/user/connections.md create mode 100644 docs/sv-rSE/user/desktop.md create mode 100644 docs/sv-rSE/user/discovery.md create mode 100644 docs/sv-rSE/user/firmware.md create mode 100644 docs/sv-rSE/user/map-and-waypoints.md create mode 100644 docs/sv-rSE/user/messages-and-channels.md create mode 100644 docs/sv-rSE/user/mqtt.md create mode 100644 docs/sv-rSE/user/node-metrics.md create mode 100644 docs/sv-rSE/user/nodes.md create mode 100644 docs/sv-rSE/user/onboarding.md create mode 100644 docs/sv-rSE/user/settings-module-admin.md create mode 100644 docs/sv-rSE/user/settings-radio-user.md create mode 100644 docs/sv-rSE/user/signal-meter.md create mode 100644 docs/sv-rSE/user/tak.md create mode 100644 docs/sv-rSE/user/telemetry-and-sensors.md create mode 100644 docs/sv-rSE/user/translate.md create mode 100644 docs/sv-rSE/user/units-and-locale.md create mode 100644 docs/tr-rTR/index.md create mode 100644 docs/tr-rTR/user/connections.md create mode 100644 docs/tr-rTR/user/desktop.md create mode 100644 docs/tr-rTR/user/discovery.md create mode 100644 docs/tr-rTR/user/firmware.md create mode 100644 docs/tr-rTR/user/map-and-waypoints.md create mode 100644 docs/tr-rTR/user/messages-and-channels.md create mode 100644 docs/tr-rTR/user/mqtt.md create mode 100644 docs/tr-rTR/user/node-metrics.md create mode 100644 docs/tr-rTR/user/nodes.md create mode 100644 docs/tr-rTR/user/onboarding.md create mode 100644 docs/tr-rTR/user/settings-module-admin.md create mode 100644 docs/tr-rTR/user/settings-radio-user.md create mode 100644 docs/tr-rTR/user/signal-meter.md create mode 100644 docs/tr-rTR/user/tak.md create mode 100644 docs/tr-rTR/user/telemetry-and-sensors.md create mode 100644 docs/tr-rTR/user/translate.md create mode 100644 docs/tr-rTR/user/units-and-locale.md create mode 100644 docs/uk-rUA/index.md create mode 100644 docs/uk-rUA/user/connections.md create mode 100644 docs/uk-rUA/user/desktop.md create mode 100644 docs/uk-rUA/user/discovery.md create mode 100644 docs/uk-rUA/user/firmware.md create mode 100644 docs/uk-rUA/user/map-and-waypoints.md create mode 100644 docs/uk-rUA/user/messages-and-channels.md create mode 100644 docs/uk-rUA/user/mqtt.md create mode 100644 docs/uk-rUA/user/node-metrics.md create mode 100644 docs/uk-rUA/user/nodes.md create mode 100644 docs/uk-rUA/user/onboarding.md create mode 100644 docs/uk-rUA/user/settings-module-admin.md create mode 100644 docs/uk-rUA/user/settings-radio-user.md create mode 100644 docs/uk-rUA/user/signal-meter.md create mode 100644 docs/uk-rUA/user/tak.md create mode 100644 docs/uk-rUA/user/telemetry-and-sensors.md create mode 100644 docs/uk-rUA/user/translate.md create mode 100644 docs/uk-rUA/user/units-and-locale.md create mode 100644 docs/zh-rCN/index.md create mode 100644 docs/zh-rCN/user/connections.md create mode 100644 docs/zh-rCN/user/desktop.md create mode 100644 docs/zh-rCN/user/discovery.md create mode 100644 docs/zh-rCN/user/firmware.md create mode 100644 docs/zh-rCN/user/map-and-waypoints.md create mode 100644 docs/zh-rCN/user/messages-and-channels.md create mode 100644 docs/zh-rCN/user/mqtt.md create mode 100644 docs/zh-rCN/user/node-metrics.md create mode 100644 docs/zh-rCN/user/nodes.md create mode 100644 docs/zh-rCN/user/onboarding.md create mode 100644 docs/zh-rCN/user/settings-module-admin.md create mode 100644 docs/zh-rCN/user/settings-radio-user.md create mode 100644 docs/zh-rCN/user/signal-meter.md create mode 100644 docs/zh-rCN/user/tak.md create mode 100644 docs/zh-rCN/user/telemetry-and-sensors.md create mode 100644 docs/zh-rCN/user/translate.md create mode 100644 docs/zh-rCN/user/units-and-locale.md create mode 100644 docs/zh-rTW/index.md create mode 100644 docs/zh-rTW/user/connections.md create mode 100644 docs/zh-rTW/user/desktop.md create mode 100644 docs/zh-rTW/user/discovery.md create mode 100644 docs/zh-rTW/user/firmware.md create mode 100644 docs/zh-rTW/user/map-and-waypoints.md create mode 100644 docs/zh-rTW/user/messages-and-channels.md create mode 100644 docs/zh-rTW/user/mqtt.md create mode 100644 docs/zh-rTW/user/node-metrics.md create mode 100644 docs/zh-rTW/user/nodes.md create mode 100644 docs/zh-rTW/user/onboarding.md create mode 100644 docs/zh-rTW/user/settings-module-admin.md create mode 100644 docs/zh-rTW/user/settings-radio-user.md create mode 100644 docs/zh-rTW/user/signal-meter.md create mode 100644 docs/zh-rTW/user/tak.md create mode 100644 docs/zh-rTW/user/telemetry-and-sensors.md create mode 100644 docs/zh-rTW/user/translate.md create mode 100644 docs/zh-rTW/user/units-and-locale.md diff --git a/androidApp/README.md b/androidApp/README.md index cc4b8cafe..c5c172202 100644 --- a/androidApp/README.md +++ b/androidApp/README.md @@ -49,6 +49,7 @@ graph TB :androidApp -.-> :feature:map :androidApp -.-> :feature:node :androidApp -.-> :feature:settings + :androidApp -.-> :feature:docs :androidApp -.-> :feature:firmware :androidApp -.-> :feature:wifi-provision :androidApp -.-> :feature:widget diff --git a/androidApp/src/main/assets/device_hardware.json b/androidApp/src/main/assets/device_hardware.json index 297ff98dc..e701bbc43 100644 --- a/androidApp/src/main/assets/device_hardware.json +++ b/androidApp/src/main/assets/device_hardware.json @@ -1398,5 +1398,20 @@ "images": [ "mini-epaper-s3.svg" ] + }, + { + "hwModel": 127, + "hwModelSlug": "HELTEC_MESH_NODE_T096", + "platformioTarget": "heltec-mesh-node-t096", + "architecture": "nrf52840", + "activelySupported": false, + "supportLevel": 1, + "displayName": "Heltec Mesh Node 096", + "tags": [ + "Heltec" + ], + "images": [ + "heltec-mesh-node-t096.svg" + ] } ] \ No newline at end of file diff --git a/core/resources/src/commonMain/composeResources/values-ar/strings.xml b/core/resources/src/commonMain/composeResources/values-ar/strings.xml index 92ac33871..9d5bde219 100644 --- a/core/resources/src/commonMain/composeResources/values-ar/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ar/strings.xml @@ -70,6 +70,8 @@ إعدادات الشاشة المسافة + + MQTT تعديل 8 ساعات diff --git a/core/resources/src/commonMain/composeResources/values-be/strings.xml b/core/resources/src/commonMain/composeResources/values-be/strings.xml index dba5380ae..c8dc859b2 100644 --- a/core/resources/src/commonMain/composeResources/values-be/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-be/strings.xml @@ -85,6 +85,9 @@ Экран Адлегласць + + MQTT + Начало работы Сцягнуць Змяніць 8 Гадзін diff --git a/core/resources/src/commonMain/composeResources/values-bg/strings.xml b/core/resources/src/commonMain/composeResources/values-bg/strings.xml index 41b3abdd7..901ae1d6a 100644 --- a/core/resources/src/commonMain/composeResources/values-bg/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-bg/strings.xml @@ -262,6 +262,13 @@ Измервания на разстояния Показване на разстоянието между вашия телефон и други възли на Meshtastic с позиции. DNS + + Изчистване на търсенето + Връзки + Откриване + MQTT + Възли + Първи стъпки Готово Да не се показва отново за това устройство Downlink активиран diff --git a/core/resources/src/commonMain/composeResources/values-ca/strings.xml b/core/resources/src/commonMain/composeResources/values-ca/strings.xml index f03cde5db..6397542ed 100644 --- a/core/resources/src/commonMain/composeResources/values-ca/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ca/strings.xml @@ -63,6 +63,7 @@ Distància + Editar 8 Hores diff --git a/core/resources/src/commonMain/composeResources/values-cs/strings.xml b/core/resources/src/commonMain/composeResources/values-cs/strings.xml index f4ba6ffe6..2477f4166 100644 --- a/core/resources/src/commonMain/composeResources/values-cs/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-cs/strings.xml @@ -287,6 +287,12 @@ Filtrovat seznam uzlů a mesh mapu podle vzdálenosti od vašeho telefonu. Měření vzdálenosti Zobrazí vzdálenost mezi vaším telefonem a ostatními uzly Meshtastic s určenou polohou. + + Vymazat hledání + Připojení + Objevujte + MQTT + Uzly Hotovo Dvojité klepnutí jako stisk tlačítka Stahování povoleno diff --git a/core/resources/src/commonMain/composeResources/values-de/strings.xml b/core/resources/src/commonMain/composeResources/values-de/strings.xml index ac9ca54fe..90d889ff7 100644 --- a/core/resources/src/commonMain/composeResources/values-de/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-de/strings.xml @@ -324,6 +324,14 @@ Entfernungsmessungen Zeigt den Abstand zwischen Ihrem Telefon und anderen Meshtastic Knoten mit einem Standort an. DNS + + Neue Suche + Verbindungen + Entdecken + Firmwareaktualisierungen + MQTT + Knoten + Erste Schritte Fertig Für dieses Gerät nicht erneut anzeigen Doppelklick als Taste @@ -731,6 +739,7 @@ Immer Benachrichtigungen stummschalten Benachrichtigungen für '%1$s ' einschalten? + Auswahl stumm schalten Immer stumm Stumm für %1$d Tage, %2$s Stunden Stumm für %1$s Stunden @@ -1135,6 +1144,7 @@ Speichern & Weiterleiten Einstellungen Speichern & Weiterleiten aktiviert Subnet + Erfolgreich Dauer Supertiefschlaf Unterstützt Unterstützt von der Meshtastic Gemeinschaft @@ -1153,8 +1163,19 @@ Teamleiter Teammitglied Unspecified + TAK Server Lokalen TAK Server aktivieren + Startet einen lokalen TLS-Server auf Port 8089 für ATAK/iTAK Verbindungen + Erstelle .zip für ATAK/iTAK um sich mit diesem Server zu verbinden + … Server + TAK Mesh Test (Debug) + Alle %1$d Tests an das Netz senden + %1$dB ✓ + ✗ + %1$d bestanden, %2$d fehlgeschlagen von %3$d/%4$d + Ausführen + Ausführen: %1$s Teamfarbe Blau Braun @@ -1247,6 +1268,7 @@ Nicht erreichbar Unbeaufsichtigt oder Infrastruktur Stummschaltung aufheben + Auswahl aktivieren Unbekannt Nicht gesetzt - 0 Up/Down/Select Eingang aktiviert @@ -1302,6 +1324,7 @@ Stellen Sie Ihrem mPWRD-OS Gerät WLAN Zugangsdaten über Bluetooth zur Verfügung. Gerät gefunden Bereit zur Suche nach WLAN Netzwerken. + Verstecktes Netzwerk Erfahren Sie mehr über das mPWRD-OS Projekt\nhttps://github.com/mPWRD-OS Keine Netzwerke gefunden Suche nach WLAN Netzwerken fehlgeschlagen: %1$s diff --git a/core/resources/src/commonMain/composeResources/values-el/strings.xml b/core/resources/src/commonMain/composeResources/values-el/strings.xml index f738b3d80..a39e97e18 100644 --- a/core/resources/src/commonMain/composeResources/values-el/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-el/strings.xml @@ -81,6 +81,8 @@ Οθόνη Απόσταση + + MQTT Επεξεργασία 8 Ώρες diff --git a/core/resources/src/commonMain/composeResources/values-es/strings.xml b/core/resources/src/commonMain/composeResources/values-es/strings.xml index d28584d86..c9b6d5fab 100644 --- a/core/resources/src/commonMain/composeResources/values-es/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-es/strings.xml @@ -250,6 +250,12 @@ Mediciones de Distancia Muestra la distancia entre tu teléfono y otros nodos Meshtastic posicionados. DNS + + Borrar búsqueda + Conexiones + MQTT + Nodos + Primeros Pasos Hecho Doble pulsación como botón Baja de Paquetes Permitida diff --git a/core/resources/src/commonMain/composeResources/values-et/strings.xml b/core/resources/src/commonMain/composeResources/values-et/strings.xml index 3d9baec58..bc67f6768 100644 --- a/core/resources/src/commonMain/composeResources/values-et/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-et/strings.xml @@ -324,6 +324,12 @@ Kauguse mõõtmised Kuva telefoni ja teiste Meshtastic sõlmede asukoha vaheline kaugus. DNS + + Puhasta otsing + Ühendus + Avastamine + MQTT + Sõlmed Valmis Ära selle seadme puhul enam kuva Topeltpuudutus nupuna @@ -731,6 +737,7 @@ Alati Vaigista teatised Tühistada '%1$s' teadete vaigistus? + Vaigista valitud Alati vaigistatud Vaigistatud %1$d päeva, %2$s tundi Vaigistatud %1$s tundi @@ -1135,6 +1142,7 @@ Salvesta & edasta sätted Salvesta & edastamine lubatud Alamvõrk + Edukas Super sügava une kestus Toetatud Toetatud Meshtastic kommuuni poolt @@ -1153,8 +1161,19 @@ Meeskonna ülem Meeskonnaliige Määramata + TAK server Kohaliku TAK-serveri lubamine + Käivitab ATAK/iTAK-ühenduste jaoks kohaliku TLS serveri, pordil 8089 + Genereeri selle serveriga ühendumiseks ATAK/iTAK-il .zip fail + … Server + TAK kärgvõrgu test (silu) + Saada kõik %1$d testkinnitust kärgvõrku + %1$dB ✓ + ✗ + %1$d läbitud, %2$d ebaõnnestunud %3$d/%4$d + Käivita + Töötav: %1$s Meeskonna värv Sinine Pruun @@ -1247,6 +1266,7 @@ Ei võta sõnumeid vastu Jälgimata või infrastruktuuripõhine Eemalda vaigistus + Lõpeta valitud vaigistus Tundmatu Tühistatud - 0 Üles/Alla/Vali sisend lubatud @@ -1302,6 +1322,7 @@ Anna mPWRD-OS-seadmele Sinihamba kaudu WiFi mandaadid. Seade leitud Valmis WiFi võrkude otsimiseks. + Peidetud võrk Lisateavet mPWRD-OS projekti kohta leiate aadressilt\nhttps://github.com/mPWRD-OS Võrke ei leitud WiFi võrkude leidmine ebaõnnestus %1$s diff --git a/core/resources/src/commonMain/composeResources/values-fi/strings.xml b/core/resources/src/commonMain/composeResources/values-fi/strings.xml index ffeeef478..db1bfd87b 100644 --- a/core/resources/src/commonMain/composeResources/values-fi/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-fi/strings.xml @@ -324,6 +324,12 @@ Etäisyyden mittaukset Näytä etäisyys puhelimen ja muiden sijainnin jakavien Meshtastic laitteiden välillä. DNS + + Tyhjennä haku + Yhteydet + Haku + MQTT + Laitteet Valmis Älä näytä enää tälle laitteelle Kaksoisnapautus painikkeena diff --git a/core/resources/src/commonMain/composeResources/values-fr/strings.xml b/core/resources/src/commonMain/composeResources/values-fr/strings.xml index 180d36124..9483cc9d1 100644 --- a/core/resources/src/commonMain/composeResources/values-fr/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-fr/strings.xml @@ -321,6 +321,12 @@ Mesures de distance Afficher la distance entre votre téléphone et les autres nœuds Meshtastic avec des positions. DNS + + Effacer la recherche + Connexions + Découverte + MQTT + Nœuds Terminé Ne plus afficher pour cet appareil Double clic comme appui sur le bouton diff --git a/core/resources/src/commonMain/composeResources/values-ga/strings.xml b/core/resources/src/commonMain/composeResources/values-ga/strings.xml index df75f7caa..68ce105f8 100644 --- a/core/resources/src/commonMain/composeResources/values-ga/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ga/strings.xml @@ -71,6 +71,7 @@ Sáth + Cuir in eagar 8 Uair an chloig diff --git a/core/resources/src/commonMain/composeResources/values-gl/strings.xml b/core/resources/src/commonMain/composeResources/values-gl/strings.xml index 0d99f2beb..14d45ce2d 100644 --- a/core/resources/src/commonMain/composeResources/values-gl/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-gl/strings.xml @@ -65,6 +65,7 @@ Distancia + Editar 8 Horas diff --git a/core/resources/src/commonMain/composeResources/values-he/strings.xml b/core/resources/src/commonMain/composeResources/values-he/strings.xml index 7f2013e7e..5f0b8c9be 100644 --- a/core/resources/src/commonMain/composeResources/values-he/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-he/strings.xml @@ -64,6 +64,7 @@ מרחק + שגיאה diff --git a/core/resources/src/commonMain/composeResources/values-hr/strings.xml b/core/resources/src/commonMain/composeResources/values-hr/strings.xml index de00f61c7..cf4b948c4 100644 --- a/core/resources/src/commonMain/composeResources/values-hr/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-hr/strings.xml @@ -69,6 +69,7 @@ Udaljenost + Uredi 8 Sati diff --git a/core/resources/src/commonMain/composeResources/values-ht/strings.xml b/core/resources/src/commonMain/composeResources/values-ht/strings.xml index ee2ee0aec..af23992da 100644 --- a/core/resources/src/commonMain/composeResources/values-ht/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ht/strings.xml @@ -68,6 +68,7 @@ Distans + Modifye 8 Èdtan diff --git a/core/resources/src/commonMain/composeResources/values-hu/strings.xml b/core/resources/src/commonMain/composeResources/values-hu/strings.xml index eeb53a454..11ebf52e9 100644 --- a/core/resources/src/commonMain/composeResources/values-hu/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-hu/strings.xml @@ -254,6 +254,10 @@ Szűrd a csomópont-listát és a mesh térképet a telefon közelsége alapján. Távolságmérés Megjeleníti a távolságot a telefonod és más, pozícióval rendelkező Meshtastic csomópontok között. + + Keresés törlése + MQTT + Csomópontok Dupla koppintás mint gomb Letöltés engedélyezve A nyilvános internetes átjáróból érkező üzenetek továbbításra kerülnek a helyi mesh hálózatra. A zéró-ugrási szabály miatt az alapértelmezett MQTT szerver forgalma nem terjed tovább ennél az eszköznél. diff --git a/core/resources/src/commonMain/composeResources/values-is/strings.xml b/core/resources/src/commonMain/composeResources/values-is/strings.xml index 1e1d6fab6..1d61f5161 100644 --- a/core/resources/src/commonMain/composeResources/values-is/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-is/strings.xml @@ -58,6 +58,7 @@ Aftengd + Hámarsksendingartíma náð. Ekki hægt að senda skilaboð, vinsamlegast reynið aftur síðar. diff --git a/core/resources/src/commonMain/composeResources/values-it/strings.xml b/core/resources/src/commonMain/composeResources/values-it/strings.xml index 7f11f97b1..87fb46eb7 100644 --- a/core/resources/src/commonMain/composeResources/values-it/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-it/strings.xml @@ -276,6 +276,12 @@ Misure di distanza Visualizza la distanza tra il telefono e gli altri nodi Meshtastic con posizione attiva. DNS + + Azzera ricerca + Connessioni + MQTT + Nodi + Come iniziare Fatto Doppio tocco come pressione pulsante Downlink attivato diff --git a/core/resources/src/commonMain/composeResources/values-ja/strings.xml b/core/resources/src/commonMain/composeResources/values-ja/strings.xml index 920316f96..e46e36327 100644 --- a/core/resources/src/commonMain/composeResources/values-ja/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ja/strings.xml @@ -192,6 +192,12 @@ 表示単位 距離 + + 検索をクリア + コネクション + ディスカバリー + MQTT + ノード ダウンリンクの有効化 動的 Echoを有効化 diff --git a/core/resources/src/commonMain/composeResources/values-ko/strings.xml b/core/resources/src/commonMain/composeResources/values-ko/strings.xml index f56d12d38..23a148ec9 100644 --- a/core/resources/src/commonMain/composeResources/values-ko/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ko/strings.xml @@ -148,6 +148,9 @@ 거리 DNS + + MQTT + 노드 다운링크 활성화 다운로드 에코 활성화 diff --git a/core/resources/src/commonMain/composeResources/values-lt/strings.xml b/core/resources/src/commonMain/composeResources/values-lt/strings.xml index 0c541ed28..402b54686 100644 --- a/core/resources/src/commonMain/composeResources/values-lt/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-lt/strings.xml @@ -72,6 +72,7 @@ Atstumas + Redaguoti 8 Valandos diff --git a/core/resources/src/commonMain/composeResources/values-nl/strings.xml b/core/resources/src/commonMain/composeResources/values-nl/strings.xml index b85928af1..8bba93e9a 100644 --- a/core/resources/src/commonMain/composeResources/values-nl/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-nl/strings.xml @@ -120,6 +120,8 @@ Geef eenheden weer Afstand + + MQTT Downlink ingeschakeld Dynamisch Echo ingeschakeld diff --git a/core/resources/src/commonMain/composeResources/values-no/strings.xml b/core/resources/src/commonMain/composeResources/values-no/strings.xml index 27349a64a..3335672b8 100644 --- a/core/resources/src/commonMain/composeResources/values-no/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-no/strings.xml @@ -73,6 +73,7 @@ Distanse + Rediger 8 Timer diff --git a/core/resources/src/commonMain/composeResources/values-pl/strings.xml b/core/resources/src/commonMain/composeResources/values-pl/strings.xml index c8fea8a74..a9c8ff1b2 100644 --- a/core/resources/src/commonMain/composeResources/values-pl/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-pl/strings.xml @@ -226,6 +226,10 @@ Odległość DNS + + Wyczyść wyszukiwanie + MQTT + Węzły Wykonano Podwójne dotknięcie jako naciśnięcie przycisku Odbiór włączony diff --git a/core/resources/src/commonMain/composeResources/values-pt-rBR/strings.xml b/core/resources/src/commonMain/composeResources/values-pt-rBR/strings.xml index eb727d403..12bed3d0b 100644 --- a/core/resources/src/commonMain/composeResources/values-pt-rBR/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-pt-rBR/strings.xml @@ -186,6 +186,11 @@ Filtre a lista de nós e o mapa da malha baseado na proximidade do seu telefone. Medição de Distâncias Exiba a distância entre o telefone e outros nós do Meshtastic com posições. + + Limpar busca + Conexões + MQTT + Nós Concluído Downlink ativado Baixar diff --git a/core/resources/src/commonMain/composeResources/values-pt/strings.xml b/core/resources/src/commonMain/composeResources/values-pt/strings.xml index a6525242c..8fb90e093 100644 --- a/core/resources/src/commonMain/composeResources/values-pt/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-pt/strings.xml @@ -150,6 +150,10 @@ Unidade de visualização Distância + + Ligações + MQTT + Nodes Downlink ativado Dinâmico Eco ativado diff --git a/core/resources/src/commonMain/composeResources/values-ro/strings.xml b/core/resources/src/commonMain/composeResources/values-ro/strings.xml index fd52022d7..bde6ecb15 100644 --- a/core/resources/src/commonMain/composeResources/values-ro/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ro/strings.xml @@ -300,6 +300,11 @@ Măsurătorile distanței Afișează distanța dintre telefonul dvs. și alte noduri Meshtastice cu poziții. DNS + + Ștergeți căutarea + Descoperiți + MQTT + Noduri Gata Apăsare dublă ca buton Downlink activat diff --git a/core/resources/src/commonMain/composeResources/values-ru/strings.xml b/core/resources/src/commonMain/composeResources/values-ru/strings.xml index fe3193c27..4a702d5d2 100644 --- a/core/resources/src/commonMain/composeResources/values-ru/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-ru/strings.xml @@ -326,6 +326,47 @@ Измерения расстояния Показать расстояния между вашим телефоном и другими нодами Meshstatic с позициями. Служба доменных имен (DNS) + + Очистить условия поиска + bluetooth,usb,tcp,pairing,serial,wifi + desktop,linux,macos,windows,serial + discovery,topology,network,scan,neighbor + firmware,update,ota,flash,version,recovery + map,waypoint,gps,position,location,marker + formatter,metric,number,locale,temperature,conversion,api + message,channel,encryption,direct,broadcast,quick-chat + mqtt,broker,internet,bridge,uplink,downlink + metrics,telemetry,signal,snr,rssi,battery,traceroute + node,mesh,list,role,status,favorite,filter + setup,welcome,permissions,first-launch + module,serial,telemetry,canned,store-forward,administration + settings,radio,lora,region,modem,device,power,security + signal,rssi,snr,bars,quality,lora,noise,meter + tak,atak,cursor-on-target,team-awareness + telemetry,sensor,temperature,humidity,pressure,power + translate,crowdin,localization,language,i18n,contribute + units,locale,metric,imperial,temperature,distance + Поиск по документации… + Руководство разработчика + Руководство пользователя + Соединения + Десктопное приложение + Обнаружение + Обновления прошивки + Карта и путевые точки + Измерение и форматирование + Сообщения и каналы + MQTT + Метрики ноды + Ноды + Начало работы + Настройки - Модули и администрирование + Настройки - Радио и пользователь + Измеритель сигнала + Интеграция TAK + Телеметрия и датчики + Перевести приложение + Ед.изм. и локализация Готово Больше не показывать для этого устройства Двойное нажатие как кнопка @@ -503,6 +544,7 @@ Модель оборудования Курс Heartbeat + Справка и документация Скрыть слой Скрыть пароль Макс возврат истории @@ -1168,8 +1210,19 @@ Руководитель команды Участник команды Не определена + Сервер TAK Включить локальный сервер TAK + Запускает локальный TLS-сервер на порту 8089 для подключений ATAK/iTAK + Создайте .zip для ATAK/iTAK, чтобы подключиться к этому серверу + ... Сервер + Сетевой тест TAK (Отладка) + Отправить все %1$d тестовых приспособлений в сеть + %1$dБ ✓ + ✗ + %1$d пройдено, %2$d неудачно из %3$d/%4$d + Запустить + Запущено: %1$s Цвет команды Синий Коричневый @@ -1239,7 +1292,7 @@ Ограничение скорости Макс пакетов в окне Окно ограничения скорости (сек.) - Сохраняить хопы маршрутизатора + Сохранять хопы маршрутизатора Порог передач неизвестных пакетов Передать через LoRa BLE diff --git a/core/resources/src/commonMain/composeResources/values-sk/strings.xml b/core/resources/src/commonMain/composeResources/values-sk/strings.xml index b588c65f1..586a2cf66 100644 --- a/core/resources/src/commonMain/composeResources/values-sk/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-sk/strings.xml @@ -130,6 +130,9 @@ Obrazovka Vzdialenosť + + Vymazať vyhľadávanie + MQTT Upraviť 8 Hodín diff --git a/core/resources/src/commonMain/composeResources/values-sl/strings.xml b/core/resources/src/commonMain/composeResources/values-sl/strings.xml index 0b8224682..c7fbd807f 100644 --- a/core/resources/src/commonMain/composeResources/values-sl/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-sl/strings.xml @@ -75,6 +75,7 @@ Razdalja + Uredi 8 Ur diff --git a/core/resources/src/commonMain/composeResources/values-sq/strings.xml b/core/resources/src/commonMain/composeResources/values-sq/strings.xml index b46c26d4e..3c936f5dd 100644 --- a/core/resources/src/commonMain/composeResources/values-sq/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-sq/strings.xml @@ -68,6 +68,7 @@ Distanca + Redakto 8 Orë diff --git a/core/resources/src/commonMain/composeResources/values-sr/strings.xml b/core/resources/src/commonMain/composeResources/values-sr/strings.xml index 4dfd45da8..0a276733c 100644 --- a/core/resources/src/commonMain/composeResources/values-sr/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-sr/strings.xml @@ -142,6 +142,9 @@ Приказ Udaljenost + + Ажурирања фирмвера + Чворови Двоструки додир као дугме Измени 8 Сати diff --git a/core/resources/src/commonMain/composeResources/values-srp/strings.xml b/core/resources/src/commonMain/composeResources/values-srp/strings.xml index dff900b16..3c6105982 100644 --- a/core/resources/src/commonMain/composeResources/values-srp/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-srp/strings.xml @@ -142,6 +142,9 @@ Приказ Раздаљина + + Ажурирања фирмвера + Чворови Двоструки додир као дугме Измени 8 Сати diff --git a/core/resources/src/commonMain/composeResources/values-sv/strings.xml b/core/resources/src/commonMain/composeResources/values-sv/strings.xml index 25b2faccb..babb2d4b7 100644 --- a/core/resources/src/commonMain/composeResources/values-sv/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-sv/strings.xml @@ -303,6 +303,12 @@ Avståndsmätning Visa avståndet mellan din telefon och andra Meshtastic noder med kända positioner. DNS + + Rensa sökning + Upptäckt + MQTT + Noder + Kom igång Klart Visa inte igen för denna enhet Dubbeltryck som knapptryck diff --git a/core/resources/src/commonMain/composeResources/values-tr/strings.xml b/core/resources/src/commonMain/composeResources/values-tr/strings.xml index 85797b2cc..f185cf715 100644 --- a/core/resources/src/commonMain/composeResources/values-tr/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-tr/strings.xml @@ -159,6 +159,11 @@ Mesafe Filtresi Uzaklık Ölçüsü DNS + + Aramayı sil + Bağlantılar + MQTT + Nodelar Aşağı bağlantı etkinleştirildi İndir Dinamik diff --git a/core/resources/src/commonMain/composeResources/values-uk/strings.xml b/core/resources/src/commonMain/composeResources/values-uk/strings.xml index 4561ed44d..82d015e8e 100644 --- a/core/resources/src/commonMain/composeResources/values-uk/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-uk/strings.xml @@ -287,6 +287,10 @@ Фільтри відстані Вимірювання відстані DNS + + Очистити пошук + MQTT + Вузли Готово Подвійний дотик як натискання кнопки Прийом увімкнений diff --git a/core/resources/src/commonMain/composeResources/values-zh-rCN/strings.xml b/core/resources/src/commonMain/composeResources/values-zh-rCN/strings.xml index d94ae3a04..88ba94c80 100644 --- a/core/resources/src/commonMain/composeResources/values-zh-rCN/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-zh-rCN/strings.xml @@ -302,6 +302,13 @@ 距离测量 显示您的手机和其他带有位置的 Meshtastic 节点之间的距离。 DNS + + 清除搜索 + 连接数 + 发现 + 固件升级 + MQTT + 节点 完成 双击作为按钮 启用下行 diff --git a/core/resources/src/commonMain/composeResources/values-zh-rTW/strings.xml b/core/resources/src/commonMain/composeResources/values-zh-rTW/strings.xml index f7e38f343..e624c7b3c 100644 --- a/core/resources/src/commonMain/composeResources/values-zh-rTW/strings.xml +++ b/core/resources/src/commonMain/composeResources/values-zh-rTW/strings.xml @@ -319,6 +319,13 @@ 距離量測 顯示您手機與其他有定位資訊的 Meshtastic 節點之間的距離。 DNS + + 清除搜尋結果 + 連線 + 尋找 + MQTT + 節點 + # 入門指南 完成 雙擊觸發按鈕功能 已啓用下行 diff --git a/docs/ar-rSA/index.md b/docs/ar-rSA/index.md new file mode 100644 index 000000000..98756518f --- /dev/null +++ b/docs/ar-rSA/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | الوصف | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/ar-rSA/user/connections.md b/docs/ar-rSA/user/connections.md new file mode 100644 index 000000000..e9cd56955 --- /dev/null +++ b/docs/ar-rSA/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | الوصف | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | انقطع الاتصال | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ar-rSA/user/desktop.md b/docs/ar-rSA/user/desktop.md new file mode 100644 index 000000000..4060f9c86 --- /dev/null +++ b/docs/ar-rSA/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| الخريطة | ✓ | ✓ | Full parity | +| الإعدادات | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ar-rSA/user/discovery.md b/docs/ar-rSA/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/ar-rSA/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ar-rSA/user/firmware.md b/docs/ar-rSA/user/firmware.md new file mode 100644 index 000000000..165a5edd1 --- /dev/null +++ b/docs/ar-rSA/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| عربي | الوصف | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ar-rSA/user/map-and-waypoints.md b/docs/ar-rSA/user/map-and-waypoints.md new file mode 100644 index 000000000..18d5af5e9 --- /dev/null +++ b/docs/ar-rSA/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | الوصف | +| ---------- | ------------------------------------------------------- | +| الاسم | Short identifier (max 30 characters) | +| الوصف | Optional longer description | +| Icon | Visual marker emoji on the map | +| مقفل | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ar-rSA/user/messages-and-channels.md b/docs/ar-rSA/user/messages-and-channels.md new file mode 100644 index 000000000..43e9c21c6 --- /dev/null +++ b/docs/ar-rSA/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## القنوات + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | الوصف | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| غلط | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| غلط | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| استغرق وقت طويل | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| لم يجد وسيط | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| لا يوجد قناه | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| طلب غير جيد | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ar-rSA/user/mqtt.md b/docs/ar-rSA/user/mqtt.md new file mode 100644 index 000000000..bfdf062c4 --- /dev/null +++ b/docs/ar-rSA/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | الوصف | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | الوصف | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | الوصف | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ar-rSA/user/node-metrics.md b/docs/ar-rSA/user/node-metrics.md new file mode 100644 index 000000000..acef754d6 --- /dev/null +++ b/docs/ar-rSA/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | الوصف | +| -------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| شدة التيار | Battery voltage reading | +| استخدام القناة | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| الحرارة | BME280, BME680, SHT31 | +| الرطوبة | BME280, BME680, SHT31 | +| الضغط الجوي | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | الوصف | +| ------------------ | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| مؤشر القوة النسبية | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | جيد | +| -10 to 0 dB | مناسب | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | الوصف | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| الحالي | Power draw in milliamps | +| Power | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## سجل الموقع + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ar-rSA/user/nodes.md b/docs/ar-rSA/user/nodes.md new file mode 100644 index 000000000..7b80e2ab4 --- /dev/null +++ b/docs/ar-rSA/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | الوصف | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Request position + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| عربي | الوصف | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | الوصف | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| آخر ظهور | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| المسافة | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ar-rSA/user/onboarding.md b/docs/ar-rSA/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ar-rSA/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ar-rSA/user/settings-module-admin.md b/docs/ar-rSA/user/settings-module-admin.md new file mode 100644 index 000000000..b3228640a --- /dev/null +++ b/docs/ar-rSA/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | الوصف | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | الوصف | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | الوصف | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | الوصف | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | الوصف | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | الوصف | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | الوصف | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| الرسائل | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | الوصف | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | الوصف | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | الوصف | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | الوصف | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | الوصف | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | الوصف | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## الإدارة + +### Remote Administration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### إعادة التشغيل + +Remotely reboot a connected or administered node. + +### Debug Panel + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ar-rSA/user/settings-radio-user.md b/docs/ar-rSA/user/settings-radio-user.md new file mode 100644 index 000000000..3bbf19712 --- /dev/null +++ b/docs/ar-rSA/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - الإعدادات + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | الوصف | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | الوصف | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | الوصف | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| الجهة | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | الوصف | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | الوصف | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | الوصف | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | الوصف | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | الوصف | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | الوصف | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ar-rSA/user/signal-meter.md b/docs/ar-rSA/user/signal-meter.md new file mode 100644 index 000000000..d1822e68c --- /dev/null +++ b/docs/ar-rSA/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| جيد | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| مناسب | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| سيئ | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| لا يوجد | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ar-rSA/user/tak.md b/docs/ar-rSA/user/tak.md new file mode 100644 index 000000000..ae31a73b0 --- /dev/null +++ b/docs/ar-rSA/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | الوصف | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | الوصف | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | الوصف | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ar-rSA/user/telemetry-and-sensors.md b/docs/ar-rSA/user/telemetry-and-sensors.md new file mode 100644 index 000000000..05b50de21 --- /dev/null +++ b/docs/ar-rSA/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | الوصف | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| شدة التيار | Battery voltage | 3.0–4.2V (LiPo) | +| استخدام القناة | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | الحرارة | الرطوبة | Pressure | Notes | +| ------- | ------- | ------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | الوصف | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| الحالي | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ar-rSA/user/translate.md b/docs/ar-rSA/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/ar-rSA/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/ar-rSA/user/units-and-locale.md b/docs/ar-rSA/user/units-and-locale.md new file mode 100644 index 000000000..661aa7320 --- /dev/null +++ b/docs/ar-rSA/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## الحرارة + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/be-rBY/index.md b/docs/be-rBY/index.md new file mode 100644 index 000000000..20894cd66 --- /dev/null +++ b/docs/be-rBY/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Апісанне | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/be-rBY/user/connections.md b/docs/be-rBY/user/connections.md new file mode 100644 index 000000000..f421dcbd3 --- /dev/null +++ b/docs/be-rBY/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Апісанне | +| ---- | -------------- | ----------------------------- | +| 🟢 | Злучаны | Active radio link established | +| 🟡 | Злучаемся | Handshake in progress | +| 🔴 | Адлучана | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Конфигурация + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/be-rBY/user/desktop.md b/docs/be-rBY/user/desktop.md new file mode 100644 index 000000000..c92122a6f --- /dev/null +++ b/docs/be-rBY/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Абзор + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Установка + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Налады | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/be-rBY/user/discovery.md b/docs/be-rBY/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/be-rBY/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/be-rBY/user/firmware.md b/docs/be-rBY/user/firmware.md new file mode 100644 index 000000000..088ecd3ce --- /dev/null +++ b/docs/be-rBY/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Канал | Апісанне | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/be-rBY/user/map-and-waypoints.md b/docs/be-rBY/user/map-and-waypoints.md new file mode 100644 index 000000000..3b736b450 --- /dev/null +++ b/docs/be-rBY/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Зялёны | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Сіні | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Апісанне | +| ---------- | ------------------------------------------------------- | +| Назва | Short identifier (max 30 characters) | +| Апісанне | Optional longer description | +| Icon | Visual marker emoji on the map | +| Locked | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/be-rBY/user/messages-and-channels.md b/docs/be-rBY/user/messages-and-channels.md new file mode 100644 index 000000000..36ca1b47b --- /dev/null +++ b/docs/be-rBY/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Каналы + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Апісанне | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Памылка | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Памылка | Meaning | What to Do | +| --------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Скончыўся час чакання | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Няма інтэрфейсу | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Няма канала | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Няправільны запыт | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/be-rBY/user/mqtt.md b/docs/be-rBY/user/mqtt.md new file mode 100644 index 000000000..96ee17240 --- /dev/null +++ b/docs/be-rBY/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Абзор + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Конфигурация + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Апісанне | Default | +| ----------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Імя карыстальніка | Broker authentication | meshdev | +| Пароль | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Шифравание | Encrypt MQTT payload | Уключана | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Апісанне | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Апісанне | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/be-rBY/user/node-metrics.md b/docs/be-rBY/user/node-metrics.md new file mode 100644 index 000000000..7b54b1dcb --- /dev/null +++ b/docs/be-rBY/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Апісанне | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Тэмпература | BME280, BME680, SHT31 | +| Вільготнасць | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Апісанне | +| ------------------- | ----------------------------------------------------------------------------- | +| сігнал-шум | Signal-to-Noise Ratio (higher is better) | +| адносная магутнасць | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Good | +| -10 to 0 dB | Fair | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Апісанне | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| 3 | Power draw in milliamps | +| Power | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Гісторыя месцазнаходжання + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/be-rBY/user/nodes.md b/docs/be-rBY/user/nodes.md new file mode 100644 index 000000000..a39169a2a --- /dev/null +++ b/docs/be-rBY/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Апісанне | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| CLIENT | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| CLIENT MUTE | Receives but doesn't retransmit | +| CLIENT HIDDEN | Like Client Mute, plus hides from node list | +| ROUTER | Prioritizes message forwarding; stays awake to relay | +| ROUTER LATE | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| TRACKER | Optimized for position reporting at regular intervals | +| SENSOR | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK TRACKER | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Request position + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Фільтраваць | Апісанне | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Апісанне | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ----------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Апошні раз пачуты | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Адлегласць | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/be-rBY/user/onboarding.md b/docs/be-rBY/user/onboarding.md new file mode 100644 index 000000000..71a350198 --- /dev/null +++ b/docs/be-rBY/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Начало работы +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Начало работы + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/be-rBY/user/settings-module-admin.md b/docs/be-rBY/user/settings-module-admin.md new file mode 100644 index 000000000..081e6086d --- /dev/null +++ b/docs/be-rBY/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Апісанне | +| ----------------- | ------------------------------------------------------------------------ | +| Уключана | Toggle MQTT bridge | +| Сервер | MQTT broker address | +| Імя карыстальніка | Authentication username | +| Пароль | Authentication password | +| Шифравание | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Апісанне | +| ---------- | ------------------------------- | +| Уключана | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Апісанне | +| -------------------------------- | --------------------------- | +| Уключана | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Апісанне | +| ------------------------------------------ | -------------------------- | +| Уключана | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Апісанне | +| -------------------------------------- | --------------------------------- | +| Уключана | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Апісанне | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Апісанне | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Паведамленні | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Апісанне | +| --------------- | -------------------------------- | +| Уключана | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Апісанне | +| -------------------- | --------------------------------------------------------------- | +| Уключана | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Апісанне | +| -------------------------------------- | ------------------------------------ | +| Уключана | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Апісанне | +| ------------------ | ---------------------------------------------------------- | +| Уключана | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Апісанне | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Уключана | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Апісанне | +| -------------------------------------- | -------------------------- | +| Уключана | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Remote Administration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Перазагрузіць + +Remotely reboot a connected or administered node. + +### Панэль адладкі + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/be-rBY/user/settings-radio-user.md b/docs/be-rBY/user/settings-radio-user.md new file mode 100644 index 000000000..dfc0aea8e --- /dev/null +++ b/docs/be-rBY/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Апісанне | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Апісанне | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | CLIENT | +| Rebroadcast Mode | How the node retransmits messages | Усе | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Апісанне | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Рэгіён | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Хуткасць | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Апісанне | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Апісанне | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Апісанне | +| --------------------------------------- | --------------------------------------- | +| | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Апісанне | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Апісанне | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Апісанне | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Прыватны ключ | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/be-rBY/user/signal-meter.md b/docs/be-rBY/user/signal-meter.md new file mode 100644 index 000000000..c6e34b4f9 --- /dev/null +++ b/docs/be-rBY/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------ | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Good | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Fair | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Bad | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Нічога | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/be-rBY/user/tak.md b/docs/be-rBY/user/tak.md new file mode 100644 index 000000000..93c5be2e2 --- /dev/null +++ b/docs/be-rBY/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Абзор + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Конфигурация + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Апісанне | +| -------- | -------------------------- | +| Уключана | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Апісанне | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Апісанне | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Функцианал | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/be-rBY/user/telemetry-and-sensors.md b/docs/be-rBY/user/telemetry-and-sensors.md new file mode 100644 index 000000000..92cc0154b --- /dev/null +++ b/docs/be-rBY/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Абзор + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Апісанне | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| SENSOR | Тэмпература | Вільготнасць | Pressure | Notes | +| ------- | ----------- | ------------ | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| SENSOR | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| SENSOR | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Апісанне | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| 3 | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/be-rBY/user/translate.md b/docs/be-rBY/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/be-rBY/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/be-rBY/user/units-and-locale.md b/docs/be-rBY/user/units-and-locale.md new file mode 100644 index 000000000..ee856d059 --- /dev/null +++ b/docs/be-rBY/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Тэмпература + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Хуткасць + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/bg-rBG/index.md b/docs/bg-rBG/index.md new file mode 100644 index 000000000..da181a83b --- /dev/null +++ b/docs/bg-rBG/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Описание | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/bg-rBG/user/connections.md b/docs/bg-rBG/user/connections.md new file mode 100644 index 000000000..08c6403e0 --- /dev/null +++ b/docs/bg-rBG/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Връзки +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Връзки + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Описание | +| ---- | ----------------- | ----------------------------- | +| 🟢 | Свързано | Active radio link established | +| 🟡 | Свързване | Handshake in progress | +| 🔴 | Прекъсната връзка | No active connection | +| ⚪ | Not configured | Няма избрано устройство | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Конфигурация + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/bg-rBG/user/desktop.md b/docs/bg-rBG/user/desktop.md new file mode 100644 index 000000000..968302146 --- /dev/null +++ b/docs/bg-rBG/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Преглед + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Инсталация + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Бележки | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Карта | ✓ | ✓ | Full parity | +| Настройки | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Известия | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/bg-rBG/user/discovery.md b/docs/bg-rBG/user/discovery.md new file mode 100644 index 000000000..b110d9b6f --- /dev/null +++ b/docs/bg-rBG/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Откриване +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Откриване + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Трасиране на маршрут + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/bg-rBG/user/firmware.md b/docs/bg-rBG/user/firmware.md new file mode 100644 index 000000000..09ee8eaca --- /dev/null +++ b/docs/bg-rBG/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Канал | Описание | +| -------- | ------------------------------------------- | +| Стабилен | Recommended for most users; tested releases | +| Алфа | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Отстраняване на неизправности + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/bg-rBG/user/map-and-waypoints.md b/docs/bg-rBG/user/map-and-waypoints.md new file mode 100644 index 000000000..76e353efe --- /dev/null +++ b/docs/bg-rBG/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ----- | ---------------------------------------------- | +| Зелен | Online (heard recently) | +| Жълт | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Син | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Описание | +| ---------- | ------------------------------------------------------- | +| Име | Short identifier (max 30 characters) | +| Описание | Optional longer description | +| Icon | Visual marker emoji on the map | +| Заключен | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/bg-rBG/user/messages-and-channels.md b/docs/bg-rBG/user/messages-and-channels.md new file mode 100644 index 000000000..ca2b2be0d --- /dev/null +++ b/docs/bg-rBG/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - канали + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Канали + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Сигурност на канала + +Channels support multiple encryption levels: + +| Icon | Security Level | Описание | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Директни съобщения + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Доставено | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Грешка | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Грешка | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Няма интерфейс | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Няма канал | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Няма отговор | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Невалидна заявка | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Най-добри практики + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/bg-rBG/user/mqtt.md b/docs/bg-rBG/user/mqtt.md new file mode 100644 index 000000000..94e36ff39 --- /dev/null +++ b/docs/bg-rBG/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Преглед + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## Как работи + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Конфигурация + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Настройка | Описание | По подразбиране | +| ----------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Адрес на сървъра | MQTT broker hostname | mqtt.meshtastic.org | +| Потребителско име | Broker authentication | meshdev | +| Парола | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Криптиране | Encrypt MQTT payload | Активиран | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Описание | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Описание | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Най-добри практики + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Отстраняване на неизправности + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/bg-rBG/user/node-metrics.md b/docs/bg-rBG/user/node-metrics.md new file mode 100644 index 000000000..a59720bf2 --- /dev/null +++ b/docs/bg-rBG/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Метрики на устройството + +Basic operating information reported by each node: + +| Метрични | Описание | +| -------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Напрежение | Battery voltage reading | +| Използване на канала | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Време на работа | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Показатели на околната среда + +Environmental sensor data (requires compatible hardware): + +| Метрични | Sensor Examples | +| ------------------------------------ | --------------------- | +| Температура | BME280, BME680, SHT31 | +| Влажност | BME280, BME680, SHT31 | +| Барометрично налягане | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Метрични | Описание | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ------------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Добър | +| -10 to 0 dB | Задоволителен | +| < -10 dB | Poor | + +## Показатели на мощност + +Power management telemetry (requires INA sensor or compatible hardware): + +| Метрични | Описание | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Текущ | Power draw in milliamps | +| Захранване | Calculated wattage | + +## Трасиране на маршрут + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Журнал на позициите + +Historical position data for nodes that share their location: + +- GPS coordinates +- Надморска височина +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/bg-rBG/user/nodes.md b/docs/bg-rBG/user/nodes.md new file mode 100644 index 000000000..9e61b93a8 --- /dev/null +++ b/docs/bg-rBG/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Възли +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Възли + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Роля | Описание | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Клиент | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Скрит клиент | Like Client Mute, plus hides from node list | +| Рутер | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Тракер | Optimized for position reporting at regular intervals | +| Сензор | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Вижте на картата + - Поискване на позиция + - Mark as favorite + - Трасиране на маршрут + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Филтър | Описание | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Описание | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Екранна снимка | +| ----------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Ниво на батерията | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Последно чут | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Разстояние | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/bg-rBG/user/onboarding.md b/docs/bg-rBG/user/onboarding.md new file mode 100644 index 000000000..e3749c214 --- /dev/null +++ b/docs/bg-rBG/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Първи стъпки +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Първи стъпки + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/bg-rBG/user/settings-module-admin.md b/docs/bg-rBG/user/settings-module-admin.md new file mode 100644 index 000000000..44a88f34a --- /dev/null +++ b/docs/bg-rBG/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Конфигурация на модулите + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Настройка | Описание | +| ----------------- | ------------------------------------------------------------------------ | +| Активиран | Toggle MQTT bridge | +| Сървър | MQTT broker address | +| Потребителско име | Authentication username | +| Парола | Authentication password | +| Криптиране | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Настройка | Описание | +| ---------- | ------------------------------- | +| Активиран | Activate serial communication | +| Ехо | Echo received serial data back | +| Режим | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Настройка | Описание | +| -------------------------------- | --------------------------- | +| Активиран | Activate notifications | +| Предупредително съобщение | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Активно | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Настройка | Описание | +| ------------------------------------------ | -------------------------- | +| Активиран | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Записи | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Настройка | Описание | +| -------------------------------------- | --------------------------------- | +| Активиран | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Настройка | Описание | +| -------------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Качество на въздуха е активирано | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Настройка | Описание | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Съобщения | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Настройка | Описание | +| --------------- | -------------------------------- | +| Активиран | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Настройка | Описание | +| -------------------- | --------------------------------------------------------------- | +| Активиран | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Настройка | Описание | +| -------------------------------------- | ------------------------------------ | +| Активиран | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Настройка | Описание | +| ------------------ | ---------------------------------------------------------- | +| Активиран | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Настройка | Описание | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Активиран | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Приятелско име | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Настройка | Описание | +| -------------------------------------- | -------------------------- | +| Активиран | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Администриране + +### Отдалечено администриране + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Почистване на базата данни с възлите + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Рестартиране + +Remotely reboot a connected or administered node. + +### Панел за отстраняване на грешки + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/bg-rBG/user/settings-radio-user.md b/docs/bg-rBG/user/settings-radio-user.md new file mode 100644 index 000000000..fe8f2fb1f --- /dev/null +++ b/docs/bg-rBG/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - настройки + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## Потребителски настройки + +### User Profile + +| Настройка | Описание | +| ----------------- | ------------------------------------------------------------------------------------- | +| Дълго име | Your display name (up to 39 characters) | +| Кратко име | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Конфигурация на радиото + +### Конфигуриране на устройството + +| Настройка | Описание | По подразбиране | +| ------------------------------------------ | ----------------------------------------------------------------------- | --------------- | +| Роля | Node behavior (Client, Router, etc.) | Клиент | +| Режим на препредаване | How the node retransmits messages | Всички | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### Конфигуриране на LoRa + +| Настройка | Описание | По подразбиране | +| ---------------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Регион | Regulatory region for frequency bands | Unset (must configure) | +| Предварително настроен модем | Speed/range tradeoff | LongFast | +| Лимит на отскоци | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Отместване на честотата | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Диапазон | Скорост | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Конфигуриране на дисплея + +| Настройка | Описание | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| Тип OLED | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Конфигуриране на позицията + +| Настройка | Описание | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| Интервал на актуализиране на GPS | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Интелигентна позиция | Enable movement-based broadcasting | +| Фиксирана позиция | Use a manually set position | + +### Конфигуриране на захранването + +| Настройка | Описание | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Конфигуриране на мрежата + +| Настройка | Описание | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Парола за мрежата | +| NTP сървър | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Конфигуриране на Bluetooth + +| Настройка | Описание | +| ------------------ | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Режим на сдвояване | Fixed PIN, Random PIN, or No PIN | +| Фиксиран ПИН | PIN code for pairing (default: 123456) | + +### Конфигуриране на сигурността + +| Настройка | Описание | +| --------------------- | -------------------------------------------------------------------------- | +| Публичен ключ | Your node's public key (read-only) | +| Администраторски ключ | Key for remote administration | +| Частен ключ | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Управляем режим | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Екранна снимка | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/bg-rBG/user/signal-meter.md b/docs/bg-rBG/user/signal-meter.md new file mode 100644 index 000000000..6720c8ba9 --- /dev/null +++ b/docs/bg-rBG/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Добър | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Задоволителен | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Лош | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Няма | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/bg-rBG/user/tak.md b/docs/bg-rBG/user/tak.md new file mode 100644 index 000000000..8076f2a94 --- /dev/null +++ b/docs/bg-rBG/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Преглед + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Конфигурация + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Настройка | Описание | +| --------- | -------------------------- | +| Активиран | Activate TAK interop | +| Режим | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Роля | Описание | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Настройка | Описание | +| --------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Роля | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Съвместимост | Характеристики | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Отстраняване на неизправности + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/bg-rBG/user/telemetry-and-sensors.md b/docs/bg-rBG/user/telemetry-and-sensors.md new file mode 100644 index 000000000..efeb54094 --- /dev/null +++ b/docs/bg-rBG/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Преглед + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Метрични | Описание | Typical Range | +| -------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Напрежение | Battery voltage | 3.0–4.2V (LiPo) | +| Използване на канала | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Време на работа | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Сензор | Температура | Влажност | Налягане | Бележки | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Сензор | Метрични | Бележки | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Сензор | Метрични | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Показатели на мощност + +Nodes with INA-series power sensors can report: + +| Метрични | Описание | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Текущ | Power consumption (mA) | +| Захранване | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Отстраняване на неизправности + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/bg-rBG/user/translate.md b/docs/bg-rBG/user/translate.md new file mode 100644 index 000000000..cf662cb49 --- /dev/null +++ b/docs/bg-rBG/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Бележки | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## Как да допринесете + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Благодарим ви, че помогнахте за разширяването на обхвата на Meshtastic! diff --git a/docs/bg-rBG/user/units-and-locale.md b/docs/bg-rBG/user/units-and-locale.md new file mode 100644 index 000000000..7747b2106 --- /dev/null +++ b/docs/bg-rBG/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## Как работи + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Температура + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Надморска височина | +| -------------------------------- | -------------- | ---------------------- | ------------------ | +| Метрични | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Скорост + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Метрични | 12 km/h | +| Imperial (US) | 7 mph | + +## Вятър + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Метрични | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Метрични | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Радиация | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Настройка | What It Controls | Пример | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/ca-rES/index.md b/docs/ca-rES/index.md new file mode 100644 index 000000000..aa4d843c5 --- /dev/null +++ b/docs/ca-rES/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Descripció | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/ca-rES/user/connections.md b/docs/ca-rES/user/connections.md new file mode 100644 index 000000000..fd6260a35 --- /dev/null +++ b/docs/ca-rES/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Descripció | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Desconnectat | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ca-rES/user/desktop.md b/docs/ca-rES/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/ca-rES/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ca-rES/user/discovery.md b/docs/ca-rES/user/discovery.md new file mode 100644 index 000000000..9cf088539 --- /dev/null +++ b/docs/ca-rES/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traçar ruta + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ca-rES/user/firmware.md b/docs/ca-rES/user/firmware.md new file mode 100644 index 000000000..9e33992de --- /dev/null +++ b/docs/ca-rES/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canal | Descripció | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ca-rES/user/map-and-waypoints.md b/docs/ca-rES/user/map-and-waypoints.md new file mode 100644 index 000000000..e623a6210 --- /dev/null +++ b/docs/ca-rES/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Descripció | +| ---------- | ------------------------------------------------------- | +| Nom | Short identifier (max 30 characters) | +| Descripció | Optional longer description | +| Icon | Visual marker emoji on the map | +| Bloquejat | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ca-rES/user/messages-and-channels.md b/docs/ca-rES/user/messages-and-channels.md new file mode 100644 index 000000000..61d4ac58e --- /dev/null +++ b/docs/ca-rES/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Descripció | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Error | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Error | Meaning | What to Do | +| ------------------------------------ | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Temps esgotat | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Sense Interfície | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Sense canal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Sol·licitud errònia. | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ca-rES/user/mqtt.md b/docs/ca-rES/user/mqtt.md new file mode 100644 index 000000000..9052faf7e --- /dev/null +++ b/docs/ca-rES/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descripció | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Descripció | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Descripció | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ca-rES/user/node-metrics.md b/docs/ca-rES/user/node-metrics.md new file mode 100644 index 000000000..4ee4fcbe7 --- /dev/null +++ b/docs/ca-rES/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Descripció | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperature | BME280, BME680, SHT31 | +| Humidity | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Descripció | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Good | +| -10 to 0 dB | Fair | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Descripció | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Traçar ruta + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Log + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ca-rES/user/nodes.md b/docs/ca-rES/user/nodes.md new file mode 100644 index 000000000..d499a287e --- /dev/null +++ b/docs/ca-rES/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Descripció | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Sol·licitar posició + - Mark as favorite + - Traçar ruta + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtre | Descripció | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Descripció | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Última notícia | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distància | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ca-rES/user/onboarding.md b/docs/ca-rES/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ca-rES/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ca-rES/user/settings-module-admin.md b/docs/ca-rES/user/settings-module-admin.md new file mode 100644 index 000000000..53a54c2c1 --- /dev/null +++ b/docs/ca-rES/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Descripció | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Descripció | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Descripció | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Descripció | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Descripció | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Descripció | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Descripció | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Descripció | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Descripció | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Descripció | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Descripció | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Descripció | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Descripció | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Remote Administration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Reiniciar + +Remotely reboot a connected or administered node. + +### Panell de depuració + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ca-rES/user/settings-radio-user.md b/docs/ca-rES/user/settings-radio-user.md new file mode 100644 index 000000000..c9fd6e397 --- /dev/null +++ b/docs/ca-rES/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Descripció | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Descripció | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Descripció | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regió | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Descripció | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Descripció | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Descripció | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Descripció | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Descripció | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Descripció | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ca-rES/user/signal-meter.md b/docs/ca-rES/user/signal-meter.md new file mode 100644 index 000000000..d34246d0e --- /dev/null +++ b/docs/ca-rES/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Good | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Fair | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Bad | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| None | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ca-rES/user/tak.md b/docs/ca-rES/user/tak.md new file mode 100644 index 000000000..f7f1cc541 --- /dev/null +++ b/docs/ca-rES/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descripció | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Descripció | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Descripció | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ca-rES/user/telemetry-and-sensors.md b/docs/ca-rES/user/telemetry-and-sensors.md new file mode 100644 index 000000000..27a7faa4a --- /dev/null +++ b/docs/ca-rES/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Descripció | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperature | Humidity | Pressure | Notes | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Descripció | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ca-rES/user/translate.md b/docs/ca-rES/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/ca-rES/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/ca-rES/user/units-and-locale.md b/docs/ca-rES/user/units-and-locale.md new file mode 100644 index 000000000..5f391111d --- /dev/null +++ b/docs/ca-rES/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperature + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/cs-rCZ/index.md b/docs/cs-rCZ/index.md new file mode 100644 index 000000000..99b032289 --- /dev/null +++ b/docs/cs-rCZ/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Popis | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/cs-rCZ/user/connections.md b/docs/cs-rCZ/user/connections.md new file mode 100644 index 000000000..626d041ac --- /dev/null +++ b/docs/cs-rCZ/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Připojení +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Připojení + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Popis | +| ---- | -------------- | ----------------------------- | +| 🟢 | Připojeno | Active radio link established | +| 🟡 | Připojování | Handshake in progress | +| 🔴 | Odpojeno | No active connection | +| ⚪ | Not configured | Není vybráno žádné zařízení | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Nastavení + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/cs-rCZ/user/desktop.md b/docs/cs-rCZ/user/desktop.md new file mode 100644 index 000000000..dee774ea9 --- /dev/null +++ b/docs/cs-rCZ/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Poznámka | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Mapa | ✓ | ✓ | Full parity | +| Nastavení | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Požadavky: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/cs-rCZ/user/discovery.md b/docs/cs-rCZ/user/discovery.md new file mode 100644 index 000000000..73069965e --- /dev/null +++ b/docs/cs-rCZ/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Objevujte +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Objevujte + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informace o sousedech + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/cs-rCZ/user/firmware.md b/docs/cs-rCZ/user/firmware.md new file mode 100644 index 000000000..643c4aff3 --- /dev/null +++ b/docs/cs-rCZ/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanál | Popis | +| -------- | ------------------------------------------- | +| Stabilní | Recommended for most users; tested releases | +| Alfa | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/cs-rCZ/user/map-and-waypoints.md b/docs/cs-rCZ/user/map-and-waypoints.md new file mode 100644 index 000000000..d69d82a54 --- /dev/null +++ b/docs/cs-rCZ/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Zelená | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Modrá | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Popis | +| ---------- | ------------------------------------------------------- | +| Jméno | Short identifier (max 30 characters) | +| Popis | Optional longer description | +| Icon | Visual marker emoji on the map | +| Uzamknout | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/cs-rCZ/user/messages-and-channels.md b/docs/cs-rCZ/user/messages-and-channels.md new file mode 100644 index 000000000..55992c626 --- /dev/null +++ b/docs/cs-rCZ/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanály + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Zabezpečení kanálu + +Channels support multiple encryption levels: + +| Icon | Security Level | Popis | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Chyba | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Chyba | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Vypršel čas spojení | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Žádné rozhraní | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Žádný kanál | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Žádná odpověď | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Špatný požadavek | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/cs-rCZ/user/mqtt.md b/docs/cs-rCZ/user/mqtt.md new file mode 100644 index 000000000..22399976f --- /dev/null +++ b/docs/cs-rCZ/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Nastavení + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Nastavení | Popis | Výchozí | +| ----------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Adresa serveru | MQTT broker hostname | mqtt.meshtastic.org | +| Uživatelské jméno | Broker authentication | meshdev | +| Heslo | Broker authentication | large4cats | +| Kořenové téma | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Povoleno | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Popis | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Popis | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/cs-rCZ/user/node-metrics.md b/docs/cs-rCZ/user/node-metrics.md new file mode 100644 index 000000000..33e4dbc65 --- /dev/null +++ b/docs/cs-rCZ/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Metriky zařízení + +Basic operating information reported by each node: + +| Metrický | Popis | +| -------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Napětí | Battery voltage reading | +| Využití kanálu | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Doba provozu | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Metriky prostředí + +Environmental sensor data (requires compatible hardware): + +| Metrický | Sensor Examples | +| ------------------------------------ | --------------------- | +| Teplota | BME280, BME680, SHT31 | +| Vlhkost | BME280, BME680, SHT31 | +| Barometrický tlak | BME280, BMP280 | +| Odpor plynu | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metrický | Popis | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Silný | +| -10 to 0 dB | Slabý | +| < -10 dB | Poor | + +## Metriky napájení + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metrický | Popis | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Proud | Power draw in milliamps | +| Napájení | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Protokol pozic + +Historical position data for nodes that share their location: + +- GPS coordinates +- Nadm. výška +- Speed (if moving) +- Timestamp for each position report + +## Informace o sousedech + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/cs-rCZ/user/nodes.md b/docs/cs-rCZ/user/nodes.md new file mode 100644 index 000000000..cd3736aff --- /dev/null +++ b/docs/cs-rCZ/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Uzly +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Uzly + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Popis | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Senzor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Zobrazit na mapě + - Vyžádat pozici + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtr | Popis | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Popis | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ---------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Naposledy slyšen | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Vzdálenost | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/cs-rCZ/user/onboarding.md b/docs/cs-rCZ/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/cs-rCZ/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/cs-rCZ/user/settings-module-admin.md b/docs/cs-rCZ/user/settings-module-admin.md new file mode 100644 index 000000000..bb2020d66 --- /dev/null +++ b/docs/cs-rCZ/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Nastavení | Popis | +| ----------------- | ------------------------------------------------------------------------ | +| Povoleno | Toggle MQTT bridge | +| Server | MQTT broker address | +| Uživatelské jméno | Authentication username | +| Heslo | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Kořenové téma | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Nastavení | Popis | +| ---------- | ------------------------------- | +| Povoleno | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Nastavení | Popis | +| -------------------------------- | --------------------------- | +| Povoleno | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Nastavení | Popis | +| ------------------------------------------ | -------------------------- | +| Povoleno | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Nastavení | Popis | +| -------------------------------------- | --------------------------------- | +| Povoleno | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Nastavení | Popis | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Nastavení | Popis | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Zprávy | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Nastavení | Popis | +| --------------- | -------------------------------- | +| Povoleno | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Nastavení | Popis | +| -------------------- | --------------------------------------------------------------- | +| Povoleno | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Nastavení | Popis | +| -------------------------------------- | ------------------------------------ | +| Povoleno | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Nastavení | Popis | +| ------------------ | ---------------------------------------------------------- | +| Povoleno | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Nastavení | Popis | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Povoleno | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Nastavení | Popis | +| -------------------------------------- | -------------------------- | +| Povoleno | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administrace + +### Vzdálená administrace + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Vyčistit databázi uzlů + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Restartovat + +Remotely reboot a connected or administered node. + +### Panel pro ladění + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/cs-rCZ/user/settings-radio-user.md b/docs/cs-rCZ/user/settings-radio-user.md new file mode 100644 index 000000000..7cfdb94c0 --- /dev/null +++ b/docs/cs-rCZ/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - nastavení + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Nastavení | Popis | +| ----------------- | ------------------------------------------------------------------------------------- | +| Dlouhé jméno | Your display name (up to 39 characters) | +| Krátké jméno | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Nastavení zařízení + +| Nastavení | Popis | Výchozí | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Režim opětovného vysílání | How the node retransmits messages | Vše | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa nastavení + +| Nastavení | Popis | Výchozí | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Region | Regulatory region for frequency bands | Unset (must configure) | +| Předvolba modemu | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Rychlost | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Nastavení zobrazení + +| Nastavení | Popis | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Nastavení pozice + +| Nastavení | Popis | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Chytrá poloha | Enable movement-based broadcasting | +| Pevná poloha | Use a manually set position | + +### Nastavení napájení + +| Nastavení | Popis | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Nastavení sítě + +| Nastavení | Popis | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Nastavení bluetooth + +| Nastavení | Popis | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Režim párování | Fixed PIN, Random PIN, or No PIN | +| Pevný PIN | PIN code for pairing (default: 123456) | + +### Nastavení zabezpečení + +| Nastavení | Popis | +| --------------------- | -------------------------------------------------------------------------- | +| Veřejný klíč | Your node's public key (read-only) | +| Administrátorský klíč | Key for remote administration | +| Soukromý klíč | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Řízený režim | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/cs-rCZ/user/signal-meter.md b/docs/cs-rCZ/user/signal-meter.md new file mode 100644 index 000000000..c6a0cc57d --- /dev/null +++ b/docs/cs-rCZ/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------ | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Silný | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Slabý | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Špatný | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Žádný | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/cs-rCZ/user/tak.md b/docs/cs-rCZ/user/tak.md new file mode 100644 index 000000000..792f08741 --- /dev/null +++ b/docs/cs-rCZ/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Nastavení + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Nastavení | Popis | +| --------- | -------------------------- | +| Povoleno | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Popis | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Nastavení | Popis | +| --------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/cs-rCZ/user/telemetry-and-sensors.md b/docs/cs-rCZ/user/telemetry-and-sensors.md new file mode 100644 index 000000000..64181c5fb --- /dev/null +++ b/docs/cs-rCZ/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metrický | Popis | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Napětí | Battery voltage | 3.0–4.2V (LiPo) | +| Využití kanálu | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Doba provozu | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Senzor | Teplota | Vlhkost | Tlak | Poznámka | +| ------- | ------- | ------- | ---- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Senzor | Metrický | Poznámka | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Senzor | Metrický | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Metriky napájení + +Nodes with INA-series power sensors can report: + +| Metrický | Popis | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Proud | Power consumption (mA) | +| Napájení | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/cs-rCZ/user/translate.md b/docs/cs-rCZ/user/translate.md new file mode 100644 index 000000000..ce2837991 --- /dev/null +++ b/docs/cs-rCZ/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Poznámka | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## Jak přispět + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Děkujeme, že jste pomohli rozšířit dosah Meshtastic! diff --git a/docs/cs-rCZ/user/units-and-locale.md b/docs/cs-rCZ/user/units-and-locale.md new file mode 100644 index 000000000..9aa3d7bc3 --- /dev/null +++ b/docs/cs-rCZ/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Teplota + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Nadm. výška | +| -------------------------------- | -------------- | ---------------------- | --------------------------- | +| Metrický | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Rychlost + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrický | 12 km/h | +| Imperial (US) | 7 mph | + +## Vítr + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrický | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metrický | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometrický tlak | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiace | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Nastavení | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/de-rDE/index.md b/docs/de-rDE/index.md new file mode 100644 index 000000000..6a88b8405 --- /dev/null +++ b/docs/de-rDE/index.md @@ -0,0 +1,30 @@ +--- +title: Startseite +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Beschreibung | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/de-rDE/user/connections.md b/docs/de-rDE/user/connections.md new file mode 100644 index 000000000..23b74b3c8 --- /dev/null +++ b/docs/de-rDE/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Verbindungen +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Verbindungen + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Beschreibung | +| ---- | ------------------- | ----------------------------- | +| 🟢 | Verbunden | Active radio link established | +| 🟡 | Wird verbunden | Handshake in progress | +| 🔴 | Verbindung getrennt | No active connection | +| ⚪ | Not configured | Kein Gerät ausgewählt | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Einstellungen + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Einstellungen + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/de-rDE/user/desktop.md b/docs/de-rDE/user/desktop.md new file mode 100644 index 000000000..4ee2f3418 --- /dev/null +++ b/docs/de-rDE/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Übersicht + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Funktion | Android | Desktop | Knoten | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Karte | ✓ | ✓ | Full parity | +| Einstellungen | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Benachrichtigungen | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Tastaturkürzel + +| Tastaturkürzel | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Einstellungen öffnen | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Voraussetzungen: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Bekannte Einschränkungen + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/de-rDE/user/discovery.md b/docs/de-rDE/user/discovery.md new file mode 100644 index 000000000..a536fc436 --- /dev/null +++ b/docs/de-rDE/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Entdecken +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Entdecken + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Nachbarinformation + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/de-rDE/user/firmware.md b/docs/de-rDE/user/firmware.md new file mode 100644 index 000000000..887356185 --- /dev/null +++ b/docs/de-rDE/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmwareaktualisierungen +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmwareaktualisierungen + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Beschreibung | +| ------ | ------------------------------------------- | +| Stabil | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Fehlerbehebung + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/de-rDE/user/map-and-waypoints.md b/docs/de-rDE/user/map-and-waypoints.md new file mode 100644 index 000000000..1191b5e06 --- /dev/null +++ b/docs/de-rDE/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Farbe | Meaning | +| ----- | ---------------------------------------------- | +| Grün | Online (heard recently) | +| Gelb | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blau | Ihr eigener Knoten | + +### Kartensteuerung + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Beschreibung | +| ------------ | ------------------------------------------------------- | +| Name | Short identifier (max 30 characters) | +| Beschreibung | Optional longer description | +| Icon | Visual marker emoji on the map | +| Gesperrt | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/de-rDE/user/messages-and-channels.md b/docs/de-rDE/user/messages-and-channels.md new file mode 100644 index 000000000..1c31a91e9 --- /dev/null +++ b/docs/de-rDE/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanäle + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Kanalsicherheit + +Channels support multiple encryption levels: + +| Icon | Security Level | Beschreibung | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direktnachrichten + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Zugestellt | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Fehler | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Fehler | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Keine Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Zeitlimit erreicht | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Keine Schnittstelle | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Kein Kanal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Keine Antwort | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Ungültige Anfrage | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Bewährte Praktiken + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/de-rDE/user/mqtt.md b/docs/de-rDE/user/mqtt.md new file mode 100644 index 000000000..6e91d2665 --- /dev/null +++ b/docs/de-rDE/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Übersicht + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## So funktioniert's + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Einstellungen + +### MQTT aktivieren + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Einstellung | Beschreibung | Standardwert | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Serveradresse | MQTT broker hostname | mqtt.meshtastic.org | +| Benutzername | Broker authentication | meshdev | +| Passwort | Broker authentication | large4cats | +| Hauptthema | Base topic for messages | msh | +| Verschlüsselung | Encrypt MQTT payload | Aktiviert | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Deaktiviert | +| TLS | Secure connection to broker | Deaktiviert | +| Map Reporting | Report position to public map | Deaktiviert | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Beschreibung | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Beschreibung | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Bewährte Praktiken + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Fehlerbehebung + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/de-rDE/user/node-metrics.md b/docs/de-rDE/user/node-metrics.md new file mode 100644 index 000000000..ea61bc628 --- /dev/null +++ b/docs/de-rDE/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Gerätedaten + +Basic operating information reported by each node: + +| Metrisch | Beschreibung | +| --------------- | ----------------------------------- | +| Batterie Ladung | Current battery percentage | +| Spannung | Battery voltage reading | +| Kanalbelegung | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Laufzeit | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Umweltdaten + +Environmental sensor data (requires compatible hardware): + +| Metrisch | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatur | BME280, BME680, SHT31 | +| Luftfeuchtigkeit | BME280, BME680, SHT31 | +| Luftdruck | BME280, BMP280 | +| Gaswiderstand | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signaldaten + +Radio signal quality information: + +| Metrisch | Beschreibung | +| ----------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Sprungweite | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ------------------------ | +| > 10 dB | Excellent | +| 0 to 10 dB | Gut | +| -10 to 0 dB | Ordentliche Signalstärke | +| < -10 dB | Poor | + +## Energiedaten + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metrisch | Beschreibung | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Stromstärke | Power draw in milliamps | +| Leistung | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Standortprotokoll + +Historical position data for nodes that share their location: + +- GPS coordinates +- Höhe +- Speed (if moving) +- Timestamp for each position report + +## Nachbarinformation + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/de-rDE/user/nodes.md b/docs/de-rDE/user/nodes.md new file mode 100644 index 000000000..9334a0414 --- /dev/null +++ b/docs/de-rDE/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Knoten +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Knoten + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Rolle | Beschreibung | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client - Versteckt | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router mit Verzögerung | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Auf der Karte anzeigen + - Position anfordern + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Beschreibung | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Beschreibung | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Bildschirmfoto | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Akkustand | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Zuletzt gehört | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distanz | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/de-rDE/user/onboarding.md b/docs/de-rDE/user/onboarding.md new file mode 100644 index 000000000..b4d990b7c --- /dev/null +++ b/docs/de-rDE/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Erste Schritte +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Erste Schritte + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/de-rDE/user/settings-module-admin.md b/docs/de-rDE/user/settings-module-admin.md new file mode 100644 index 000000000..96bbe3cf1 --- /dev/null +++ b/docs/de-rDE/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Moduleinstellungen + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Einstellung | Beschreibung | +| --------------- | ------------------------------------------------------------------------ | +| Aktiviert | Toggle MQTT bridge | +| Server | MQTT broker address | +| Benutzername | Authentication username | +| Passwort | Authentication password | +| Verschlüsselung | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Hauptthema | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Einstellung | Beschreibung | +| ------------- | ------------------------------- | +| Aktiviert | Activate serial communication | +| Echo | Echo received serial data back | +| Betriebsmodus | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baudrate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Einstellung | Beschreibung | +| -------------------------------- | --------------------------- | +| Aktiviert | Activate notifications | +| Warnmeldung | Notify on incoming messages | +| Summer bei Warnmeldung | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Warnglocke | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Aktiv | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Einstellung | Beschreibung | +| ------------------------------------------ | -------------------------- | +| Aktiviert | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Datensätze | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Einstellung | Beschreibung | +| -------------------------------------- | --------------------------------- | +| Aktiviert | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Einstellung | Beschreibung | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Luftqualität aktiviert | Report particulate sensor data | +| Energiedaten aktiviert | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Einstellung | Beschreibung | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Nachrichten | Newline-separated list of messages | +| Sende Glocke | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Einstellung | Beschreibung | +| --------------- | -------------------------------- | +| Aktiviert | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Wortauswahl | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Einstellung | Beschreibung | +| -------------------- | --------------------------------------------------------------- | +| Aktiviert | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Einstellung | Beschreibung | +| -------------------------------------- | ------------------------------------ | +| Aktiviert | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Einstellung | Beschreibung | +| ------------------ | ---------------------------------------------------------- | +| Aktiviert | Activate LED control | +| LED Status | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Einstellung | Beschreibung | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Aktiviert | Activate detection sensor | +| GPIO Pin überwachen | GPIO pin connected to sensor | +| Erkennung Logik 1 | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Sende Glocke | Include bell character in alerts | +| Anzeigename | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Einstellung | Beschreibung | +| -------------------------------------- | -------------------------- | +| Aktiviert | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Einstellung + +### Ferneinstellung + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Knotendatenbank leeren + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Werkseinstellungen + +Resets all settings to factory defaults. **This cannot be undone.** + +### Neustart + +Remotely reboot a connected or administered node. + +### Debug-Ausgaben + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/de-rDE/user/settings-radio-user.md b/docs/de-rDE/user/settings-radio-user.md new file mode 100644 index 000000000..44246c7f9 --- /dev/null +++ b/docs/de-rDE/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - Einstellungen + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## Benutzereinstellungen + +### User Profile + +| Einstellung | Beschreibung | +| ----------------- | ------------------------------------------------------------------------------------- | +| Langer Name | Your display name (up to 39 characters) | +| Kurzname | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Funkgeräteeinstellung + +### Geräteeinstellungen + +| Einstellung | Beschreibung | Standardwert | +| ------------------------------------------ | ----------------------------------------------------------------------- | ------------ | +| Rolle | Node behavior (Client, Router, etc.) | Client | +| Weiterleitungsmodus | How the node retransmits messages | Alle | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Deaktiviert | + +### LoRa Einstellungen + +| Einstellung | Beschreibung | Standardwert | +| ---------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Region | Regulatory region for frequency bands | Unset (must configure) | +| Modem Voreinstellungen | Speed/range tradeoff | LongFast | +| Sprungweite | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequenzversatz | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Bereich | Geschwindigkeit | SNR Limit | Best For | +| -------------------------------- | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| SHORT_TURBO | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| MEDIUM_FAST | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| MEDIUM_SLOW | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0,34 kbit/s | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0,18 kbit/s | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Anzeigeeinstellungen + +| Einstellung | Beschreibung | +| ------------------ | ------------------------------------------------------------------------------------ | +| Anzeigeabschaltung | Time before display sleeps | +| Anzeigeeinheiten | Metric or Imperial | +| OLED Typ | Auto, SSD1306, SH1106, SH1107 | +| Kompassausrichtung | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Standorteinstellungen + +| Einstellung | Beschreibung | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Aktualisierungsintervall | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Intelligente Position | Enable movement-based broadcasting | +| Fester Standort | Use a manually set position | + +### Energie Einstellungen + +| Einstellung | Beschreibung | +| --------------------------------------- | --------------------------------------- | +| Energiesparen | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Netzwerkeinstellungen + +| Einstellung | Beschreibung | +| -------------- | ---------------------------------------------------- | +| WLAN aktiviert | Enable WiFi radio (ESP32 devices) | +| WLAN SSID | Network name to connect to | +| WLAN PSK | Netzwerkpasswort | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Einstellungen + +| Einstellung | Beschreibung | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Kopplungsmodus | Fixed PIN, Random PIN, or No PIN | +| Feste PIN | PIN code for pairing (default: 123456) | + +### Sicherheitseinstellungen + +| Einstellung | Beschreibung | +| ----------------------------------------------- | -------------------------------------------------------------------------- | +| Öffentlicher Schlüssel | Your node's public key (read-only) | +| Administrativer Schlüssel | Key for remote administration | +| Privater Schlüssel | Your node's private key (handle securely) | +| Administrativer Kanal aktiviert | Allow admin commands via channel | +| Fehlersuchprotokolle (Debug) | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Verwalteter Modus | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Bildschirmfoto | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/de-rDE/user/signal-meter.md b/docs/de-rDE/user/signal-meter.md new file mode 100644 index 000000000..f2c11bcac --- /dev/null +++ b/docs/de-rDE/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------------------------ | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Gut | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Ordentliche Signalstärke | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Schlecht | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Keins | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/de-rDE/user/tak.md b/docs/de-rDE/user/tak.md new file mode 100644 index 000000000..ba83af255 --- /dev/null +++ b/docs/de-rDE/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Übersicht + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Einstellungen + +### Voraussetzungen + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Einstellungen + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Einstellung | Beschreibung | +| ------------- | -------------------------- | +| Aktiviert | Activate TAK interop | +| Betriebsmodus | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Rolle | Beschreibung | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Einstellung | Beschreibung | +| ----------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Rolle | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Kompatibilität | Merkmale | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Fehlerbehebung + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/de-rDE/user/telemetry-and-sensors.md b/docs/de-rDE/user/telemetry-and-sensors.md new file mode 100644 index 000000000..7656a745e --- /dev/null +++ b/docs/de-rDE/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Übersicht + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Gerätetelemetrie + +All Meshtastic nodes report basic device telemetry: + +| Metrisch | Beschreibung | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Batterie Ladung | Charge percentage | 0–100% | +| Spannung | Battery voltage | 3.0–4.2V (LiPo) | +| Kanalbelegung | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Laufzeit | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatur | Luftfeuchtigkeit | Druck | Knoten | +| ------- | ---------- | ---------------- | ----- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metrisch | Knoten | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metrisch | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Energiedaten + +Nodes with INA-series power sensors can report: + +| Metrisch | Beschreibung | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Stromstärke | Power consumption (mA) | +| Leistung | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Fehlerbehebung + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/de-rDE/user/translate.md b/docs/de-rDE/user/translate.md new file mode 100644 index 000000000..8b03ee6b4 --- /dev/null +++ b/docs/de-rDE/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Knoten | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## Wie man beitragen kann + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Vielen Dank, dass Sie dabei geholfen haben, die Reichweite von Meshtastic zu vergrößern! diff --git a/docs/de-rDE/user/units-and-locale.md b/docs/de-rDE/user/units-and-locale.md new file mode 100644 index 000000000..19c264371 --- /dev/null +++ b/docs/de-rDE/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## So funktioniert's + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatur + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Höhe | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metrisch | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Geschwindigkeit + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrisch | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrisch | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metrisch | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Luftdruck | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Strahlung | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Einstellung | What It Controls | Beispiel | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/el-rGR/index.md b/docs/el-rGR/index.md new file mode 100644 index 000000000..dcc177600 --- /dev/null +++ b/docs/el-rGR/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Περιγραφή | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/el-rGR/user/connections.md b/docs/el-rGR/user/connections.md new file mode 100644 index 000000000..ab545c880 --- /dev/null +++ b/docs/el-rGR/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Περιγραφή | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Αποσυνδεδεμένο | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/el-rGR/user/desktop.md b/docs/el-rGR/user/desktop.md new file mode 100644 index 000000000..a8835b285 --- /dev/null +++ b/docs/el-rGR/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Χάρτης | ✓ | ✓ | Full parity | +| Ρυθμίσεις | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/el-rGR/user/discovery.md b/docs/el-rGR/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/el-rGR/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/el-rGR/user/firmware.md b/docs/el-rGR/user/firmware.md new file mode 100644 index 000000000..6aca7e903 --- /dev/null +++ b/docs/el-rGR/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Κανάλι | Περιγραφή | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/el-rGR/user/map-and-waypoints.md b/docs/el-rGR/user/map-and-waypoints.md new file mode 100644 index 000000000..6b1e19162 --- /dev/null +++ b/docs/el-rGR/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------- | ---------------------------------------------- | +| Πράσινο | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Μπλε | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Περιγραφή | +| ---------- | ------------------------------------------------------- | +| Ονομα | Short identifier (max 30 characters) | +| Περιγραφή | Optional longer description | +| Icon | Visual marker emoji on the map | +| Κλειδωμένο | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/el-rGR/user/messages-and-channels.md b/docs/el-rGR/user/messages-and-channels.md new file mode 100644 index 000000000..51afb5306 --- /dev/null +++ b/docs/el-rGR/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Κανάλια + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Περιγραφή | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Σφάλμα | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Σφάλμα | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Λήξη χρονικού ορίου | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| No Interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Kein Kanal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Εσφαλμένο Αίτημα | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/el-rGR/user/mqtt.md b/docs/el-rGR/user/mqtt.md new file mode 100644 index 000000000..9a044bed3 --- /dev/null +++ b/docs/el-rGR/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Περιγραφή | Default | +| ----------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Όνομα χρήστη | Broker authentication | meshdev | +| Κωδικός πρόσβασης | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Περιγραφή | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Περιγραφή | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/el-rGR/user/node-metrics.md b/docs/el-rGR/user/node-metrics.md new file mode 100644 index 000000000..0edc97f2e --- /dev/null +++ b/docs/el-rGR/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Περιγραφή | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Τάση | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Θερμοκρασία | BME280, BME680, SHT31 | +| Υγρασία | BME280, BME680, SHT31 | +| Βαρομετρική Πίεση | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Περιγραφή | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Good | +| -10 to 0 dB | Fair | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Περιγραφή | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Αρχείο Καταγραφής Τοποθεσίας + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/el-rGR/user/nodes.md b/docs/el-rGR/user/nodes.md new file mode 100644 index 000000000..522725a85 --- /dev/null +++ b/docs/el-rGR/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Περιγραφή | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Πελάτης Βάση | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Αίτηση θέσης + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Φίλτρο | Περιγραφή | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Περιγραφή | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Last heard | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Απόσταση | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/el-rGR/user/onboarding.md b/docs/el-rGR/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/el-rGR/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/el-rGR/user/settings-module-admin.md b/docs/el-rGR/user/settings-module-admin.md new file mode 100644 index 000000000..fa01de82b --- /dev/null +++ b/docs/el-rGR/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Περιγραφή | +| ----------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Όνομα χρήστη | Authentication username | +| Κωδικός πρόσβασης | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Περιγραφή | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Περιγραφή | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Περιγραφή | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Περιγραφή | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Περιγραφή | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Περιγραφή | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Μηνύματα | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Περιγραφή | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Περιγραφή | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Περιγραφή | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Περιγραφή | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Περιγραφή | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Περιγραφή | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Διαχείριση + +### Απομακρυσμένη Διαχείριση + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Επανεκκίνηση + +Remotely reboot a connected or administered node. + +### Πίνακας αποσφαλμάτωσης + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/el-rGR/user/settings-radio-user.md b/docs/el-rGR/user/settings-radio-user.md new file mode 100644 index 000000000..d4174e3b5 --- /dev/null +++ b/docs/el-rGR/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - ρυθμίσεις + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Περιγραφή | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Περιγραφή | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Περιγραφή | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Περιφέρεια | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Περιγραφή | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Περιγραφή | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Περιγραφή | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Περιγραφή | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Ρυθμίσεις Bluetooth + +| Setting | Περιγραφή | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Περιγραφή | +| --------------------- | -------------------------------------------------------------------------- | +| Δημόσιο Κλειδί | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Ιδιωτικό Κλειδί | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/el-rGR/user/signal-meter.md b/docs/el-rGR/user/signal-meter.md new file mode 100644 index 000000000..d34246d0e --- /dev/null +++ b/docs/el-rGR/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Good | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Fair | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Bad | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| None | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/el-rGR/user/tak.md b/docs/el-rGR/user/tak.md new file mode 100644 index 000000000..85d2dfd01 --- /dev/null +++ b/docs/el-rGR/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Περιγραφή | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Περιγραφή | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Περιγραφή | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/el-rGR/user/telemetry-and-sensors.md b/docs/el-rGR/user/telemetry-and-sensors.md new file mode 100644 index 000000000..c112d632a --- /dev/null +++ b/docs/el-rGR/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Περιγραφή | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Τάση | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Θερμοκρασία | Υγρασία | Pressure | Notes | +| ------- | ----------- | ------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Περιγραφή | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/el-rGR/user/translate.md b/docs/el-rGR/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/el-rGR/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/el-rGR/user/units-and-locale.md b/docs/el-rGR/user/units-and-locale.md new file mode 100644 index 000000000..84c58202b --- /dev/null +++ b/docs/el-rGR/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Θερμοκρασία + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/es-rES/index.md b/docs/es-rES/index.md new file mode 100644 index 000000000..94aac92d3 --- /dev/null +++ b/docs/es-rES/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Descripción | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/es-rES/user/connections.md b/docs/es-rES/user/connections.md new file mode 100644 index 000000000..74da314e9 --- /dev/null +++ b/docs/es-rES/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Conexiones +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Conexiones + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Descripción | +| ---- | -------------- | ----------------------------- | +| 🟢 | Conectado | Active radio link established | +| 🟡 | Conectando | Handshake in progress | +| 🔴 | Desconectado | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuración + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/es-rES/user/desktop.md b/docs/es-rES/user/desktop.md new file mode 100644 index 000000000..522c09f34 --- /dev/null +++ b/docs/es-rES/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Visión general + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notas | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Mapa | ✓ | ✓ | Full parity | +| Ajustes | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/es-rES/user/discovery.md b/docs/es-rES/user/discovery.md new file mode 100644 index 000000000..469a2c684 --- /dev/null +++ b/docs/es-rES/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Información de Vecinos + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/es-rES/user/firmware.md b/docs/es-rES/user/firmware.md new file mode 100644 index 000000000..cedda2abc --- /dev/null +++ b/docs/es-rES/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canal | Descripción | +| ------- | ------------------------------------------- | +| Estable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/es-rES/user/map-and-waypoints.md b/docs/es-rES/user/map-and-waypoints.md new file mode 100644 index 000000000..7c0f0802e --- /dev/null +++ b/docs/es-rES/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Verde | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Azul | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Descripción | +| ----------- | ------------------------------------------------------- | +| Nombre | Short identifier (max 30 characters) | +| Descripción | Optional longer description | +| Icon | Visual marker emoji on the map | +| Bloqueado | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/es-rES/user/messages-and-channels.md b/docs/es-rES/user/messages-and-channels.md new file mode 100644 index 000000000..6a9b86074 --- /dev/null +++ b/docs/es-rES/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Canales + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Seguridad del canal + +Channels support multiple encryption levels: + +| Icon | Security Level | Descripción | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Error | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Error | Meaning | What to Do | +| ----------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Tiempo agotado | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Sin interfaz | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| No hay canal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Solicitud errónea | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/es-rES/user/mqtt.md b/docs/es-rES/user/mqtt.md new file mode 100644 index 000000000..3bc91e795 --- /dev/null +++ b/docs/es-rES/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Visión general + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuración + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descripción | Por defecto | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Usuario | Broker authentication | meshdev | +| Contraseña | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Cifrado | Encrypt MQTT payload | Habilitado | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Descripción | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Descripción | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/es-rES/user/node-metrics.md b/docs/es-rES/user/node-metrics.md new file mode 100644 index 000000000..c9c2bff82 --- /dev/null +++ b/docs/es-rES/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Métricas de Dispositivo + +Basic operating information reported by each node: + +| Métrico | Descripción | +| --------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Tensión | Battery voltage reading | +| Utilización del canal | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Tiempo encendido | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Métricas de Entorno + +Environmental sensor data (requires compatible hardware): + +| Métrico | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatura: | BME280, BME680, SHT31 | +| Humedad | BME280, BME680, SHT31 | +| Presión Barométrica | BME280, BMP280 | +| Resistencia del Gas | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Métrico | Descripción | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Bien | +| -10 to 0 dB | Aceptable | +| < -10 dB | Poor | + +## Métricas de Energía + +Power management telemetry (requires INA sensor or compatible hardware): + +| Métrico | Descripción | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Intensidad | Power draw in milliamps | +| Consumo | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Registro de Posiciones + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitud +- Speed (if moving) +- Timestamp for each position report + +## Información de Vecinos + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/es-rES/user/nodes.md b/docs/es-rES/user/nodes.md new file mode 100644 index 000000000..a2b7209d3 --- /dev/null +++ b/docs/es-rES/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodos +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodos + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Rol | Descripción | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Cliente | Standard end-user device | +| Base cliente | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Cliente silenciado | Receives but doesn't retransmit | +| Cliente oculto | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Rastreador | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| Rastreador TAK | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Ver en el mapa + - Solicitar posición + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtro | Descripción | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Descripción | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Última escucha | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distancia | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/es-rES/user/onboarding.md b/docs/es-rES/user/onboarding.md new file mode 100644 index 000000000..040821b5d --- /dev/null +++ b/docs/es-rES/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Primeros Pasos +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Primeros Pasos + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/es-rES/user/settings-module-admin.md b/docs/es-rES/user/settings-module-admin.md new file mode 100644 index 000000000..23f4c3a3f --- /dev/null +++ b/docs/es-rES/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Descripción | +| --------------- | ------------------------------------------------------------------------ | +| Habilitado | Toggle MQTT bridge | +| Servidor | MQTT broker address | +| Usuario | Authentication username | +| Contraseña | Authentication password | +| Cifrado | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Descripción | +| ---------- | ------------------------------- | +| Habilitado | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Descripción | +| -------------------------------- | --------------------------- | +| Habilitado | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Descripción | +| ------------------------------------------ | -------------------------- | +| Habilitado | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Registros | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Descripción | +| -------------------------------------- | --------------------------------- | +| Habilitado | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Descripción | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Descripción | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Mensajes | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Descripción | +| --------------- | -------------------------------- | +| Habilitado | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Descripción | +| -------------------- | --------------------------------------------------------------- | +| Habilitado | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Descripción | +| -------------------------------------- | ------------------------------------ | +| Habilitado | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Descripción | +| ------------------ | ---------------------------------------------------------- | +| Habilitado | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Descripción | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Habilitado | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Descripción | +| -------------------------------------- | -------------------------- | +| Habilitado | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administración + +### Administración remota + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Limpiar nodos de la base de datos + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Reiniciar + +Remotely reboot a connected or administered node. + +### Panel de depuración + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/es-rES/user/settings-radio-user.md b/docs/es-rES/user/settings-radio-user.md new file mode 100644 index 000000000..d061d19cc --- /dev/null +++ b/docs/es-rES/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - ajustes + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Descripción | +| ----------------- | ------------------------------------------------------------------------------------- | +| Nombre largo | Your display name (up to 39 characters) | +| Nombre Corto | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Configuración del dispositivo + +| Setting | Descripción | Por defecto | +| ------------------------------------------ | ----------------------------------------------------------------------- | ----------- | +| Rol | Node behavior (Client, Router, etc.) | Cliente | +| Modo de retransmisión | How the node retransmits messages | Todos | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### Configuración LoRa + +| Setting | Descripción | Por defecto | +| ---------------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Región | Regulatory region for frequency bands | Unset (must configure) | +| Modem predefinido | Speed/range tradeoff | LongFast | +| Límite de Saltos | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Desplazamiento de frecuencia | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Velocidad | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Configuración de pantalla + +| Setting | Descripción | +| ------------------------------- | ------------------------------------------------------------------------------------ | +| Tiempo de espera de la pantalla | Time before display sleeps | +| Unidades de medidas | Metric or Imperial | +| Tipo de OLED | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Configuración de la posición + +| Setting | Descripción | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| Intervalo de actualización GPS | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Ubicación inteligente | Enable movement-based broadcasting | +| Posición fija | Use a manually set position | + +### Configuración de elecenergía + +| Setting | Descripción | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Configuración de la red + +| Setting | Descripción | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Contraseña de red | +| Servidor NTP | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Configuración Bluetooth + +| Setting | Descripción | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Pin fijo | PIN code for pairing (default: 123456) | + +### Configuración de la seguridad + +| Setting | Descripción | +| --------------------------------- | -------------------------------------------------------------------------- | +| Clave Pública | Your node's public key (read-only) | +| Contraseña de administrador | Key for remote administration | +| Clave privada | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Modo "ya terminado de configurar" | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/es-rES/user/signal-meter.md b/docs/es-rES/user/signal-meter.md new file mode 100644 index 000000000..20724df71 --- /dev/null +++ b/docs/es-rES/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| --------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Bien | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Aceptable | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Mal | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Ninguna | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/es-rES/user/tak.md b/docs/es-rES/user/tak.md new file mode 100644 index 000000000..eb53bb641 --- /dev/null +++ b/docs/es-rES/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Visión general + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuración + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descripción | +| ---------- | -------------------------- | +| Habilitado | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Rol | Descripción | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Descripción | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Rol | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/es-rES/user/telemetry-and-sensors.md b/docs/es-rES/user/telemetry-and-sensors.md new file mode 100644 index 000000000..b538eafcc --- /dev/null +++ b/docs/es-rES/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Visión general + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Métrico | Descripción | Typical Range | +| --------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Tensión | Battery voltage | 3.0–4.2V (LiPo) | +| Utilización del canal | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Tiempo encendido | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatura: | Humedad | Presión | Notas | +| ------- | ---------------------------- | ------- | ------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Métrico | Notas | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Métrico | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Métricas de Energía + +Nodes with INA-series power sensors can report: + +| Métrico | Descripción | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Intensidad | Power consumption (mA) | +| Consumo | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/es-rES/user/translate.md b/docs/es-rES/user/translate.md new file mode 100644 index 000000000..61d69b71d --- /dev/null +++ b/docs/es-rES/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notas | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/es-rES/user/units-and-locale.md b/docs/es-rES/user/units-and-locale.md new file mode 100644 index 000000000..355fb1ac9 --- /dev/null +++ b/docs/es-rES/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatura: + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitud | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Métrico | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Velocidad + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Métrico | 12 km/h | +| Imperial (US) | 7 mph | + +## Viento + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Métrico | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Métrico | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiación | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/et-rEE/index.md b/docs/et-rEE/index.md new file mode 100644 index 000000000..d751b9a5d --- /dev/null +++ b/docs/et-rEE/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Kirjeldus | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/et-rEE/user/connections.md b/docs/et-rEE/user/connections.md new file mode 100644 index 000000000..17f765662 --- /dev/null +++ b/docs/et-rEE/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Ühendus +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Ühendus + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Kirjeldus | +| ---- | ---------------- | ----------------------------- | +| 🟢 | Ühendatud | Active radio link established | +| 🟡 | Ühendan | Handshake in progress | +| 🔴 | Ühendus katkenud | No active connection | +| ⚪ | Not configured | Seadet pole valitud | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Sätted + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/et-rEE/user/desktop.md b/docs/et-rEE/user/desktop.md new file mode 100644 index 000000000..7a9c802b6 --- /dev/null +++ b/docs/et-rEE/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Sõnumid | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Kaart | ✓ | ✓ | Full parity | +| Sätted | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/et-rEE/user/discovery.md b/docs/et-rEE/user/discovery.md new file mode 100644 index 000000000..0860f6cc4 --- /dev/null +++ b/docs/et-rEE/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Avastamine +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Avastamine + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Marsruudi + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Naabruse teave + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/et-rEE/user/firmware.md b/docs/et-rEE/user/firmware.md new file mode 100644 index 000000000..35ef057d5 --- /dev/null +++ b/docs/et-rEE/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Kirjeldus | +| --------- | ------------------------------------------- | +| Stabiilne | Recommended for most users; tested releases | +| Alfa | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/et-rEE/user/map-and-waypoints.md b/docs/et-rEE/user/map-and-waypoints.md new file mode 100644 index 000000000..6621230c7 --- /dev/null +++ b/docs/et-rEE/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| -------- | ---------------------------------------------- | +| Roheline | Online (heard recently) | +| Kollane | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Sinine | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Kirjeldus | +| ---------- | ------------------------------------------------------- | +| Nimi | Short identifier (max 30 characters) | +| Kirjeldus | Optional longer description | +| Icon | Visual marker emoji on the map | +| Lukustatud | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/et-rEE/user/messages-and-channels.md b/docs/et-rEE/user/messages-and-channels.md new file mode 100644 index 000000000..e1f3d014e --- /dev/null +++ b/docs/et-rEE/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanal + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Kanali turvalisus + +Channels support multiple encryption levels: + +| Icon | Security Level | Kirjeldus | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Tõrge | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Tõrge | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Aegunud | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Liidest pole | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Kanalit pole | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Vastust pole | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Vigane päring | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/et-rEE/user/mqtt.md b/docs/et-rEE/user/mqtt.md new file mode 100644 index 000000000..0f2e16849 --- /dev/null +++ b/docs/et-rEE/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Sätted + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Kirjeldus | Vaikimisi | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Kasutajatunnus | Broker authentication | meshdev | +| Parool | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Lubatud | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Kirjeldus | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Kirjeldus | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/et-rEE/user/node-metrics.md b/docs/et-rEE/user/node-metrics.md new file mode 100644 index 000000000..28296aa89 --- /dev/null +++ b/docs/et-rEE/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Seadme mõõdikud + +Basic operating information reported by each node: + +| Metric | Kirjeldus | +| -------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Vool | Battery voltage reading | +| Kanali kasutus | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Töötamise aeg | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Keskkonnamõõdikud + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatuur | BME280, BME680, SHT31 | +| Niiskus | BME280, BME680, SHT31 | +| Baromeetri rõhk | BME280, BMP280 | +| Gaasi surve | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signaali mõõdikud + +Radio signal quality information: + +| Metric | Kirjeldus | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Hea | +| -10 to 0 dB | Rahuldav | +| < -10 dB | Poor | + +## Võimsusnäitajad + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Kirjeldus | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Pinge | Power draw in milliamps | +| Toide | Calculated wattage | + +## Marsruudi + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Asukoha logi + +Historical position data for nodes that share their location: + +- GPS coordinates +- Kõrgus +- Speed (if moving) +- Timestamp for each position report + +## Naabruse teave + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/et-rEE/user/nodes.md b/docs/et-rEE/user/nodes.md new file mode 100644 index 000000000..13aa6b1d1 --- /dev/null +++ b/docs/et-rEE/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Sõlmed +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Sõlmed + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Roll | Kirjeldus | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Klient | Standard end-user device | +| Klient-baas | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Vaikne klient | Receives but doesn't retransmit | +| Peidetud klient | Like Client Mute, plus hides from node list | +| Ruuter | Prioritizes message forwarding; stays awake to relay | +| Hiline ruuter | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Jälgitav | Optimized for position reporting at regular intervals | +| Andur | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| Jälgitav TAK | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Vaata kaardil + - Küsi asukohta + - Mark as favorite + - Marsruudi + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtreeri | Kirjeldus | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Kirjeldus | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| --------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Viimati kuuldud | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Kaugus | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/et-rEE/user/onboarding.md b/docs/et-rEE/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/et-rEE/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/et-rEE/user/settings-module-admin.md b/docs/et-rEE/user/settings-module-admin.md new file mode 100644 index 000000000..7ee05661f --- /dev/null +++ b/docs/et-rEE/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Kirjeldus | +| --------------- | ------------------------------------------------------------------------ | +| Lubatud | Toggle MQTT bridge | +| Server | MQTT broker address | +| Kasutajatunnus | Authentication username | +| Parool | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Kirjeldus | +| ---------- | ------------------------------- | +| Lubatud | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Kirjeldus | +| -------------------------------- | --------------------------- | +| Lubatud | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Kirjeldus | +| ------------------------------------------ | -------------------------- | +| Lubatud | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Kirjeldus | +| -------------------------------------- | --------------------------------- | +| Lubatud | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Kirjeldus | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Kirjeldus | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Sõnumid | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Kirjeldus | +| --------------- | -------------------------------- | +| Lubatud | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Kirjeldus | +| -------------------- | --------------------------------------------------------------- | +| Lubatud | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Kirjeldus | +| -------------------------------------- | ------------------------------------ | +| Lubatud | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Kirjeldus | +| ------------------ | ---------------------------------------------------------- | +| Lubatud | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Kirjeldus | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Lubatud | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Kirjeldus | +| -------------------------------------- | -------------------------- | +| Lubatud | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Haldus + +### Kaughaldus + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Tühjenda sõlmede andmebaas + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Taaskäivita + +Remotely reboot a connected or administered node. + +### Arendaja paneel + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/et-rEE/user/settings-radio-user.md b/docs/et-rEE/user/settings-radio-user.md new file mode 100644 index 000000000..7614d63d5 --- /dev/null +++ b/docs/et-rEE/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - sätted + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Kirjeldus | +| ----------------- | ------------------------------------------------------------------------------------- | +| Täis nimi | Your display name (up to 39 characters) | +| Lühi nimi | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Seadme sätted + +| Setting | Kirjeldus | Vaikimisi | +| ------------------------------------------ | ----------------------------------------------------------------------- | --------- | +| Roll | Node behavior (Client, Router, etc.) | Klient | +| Kordusülekannete režiim | How the node retransmits messages | Kõik | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa sätted + +| Setting | Kirjeldus | Vaikimisi | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regioon | Regulatory region for frequency bands | Unset (must configure) | +| Modemi vaikesäte | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Kiirus | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Ekraani sätted + +| Setting | Kirjeldus | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Asukoha sätted + +| Setting | Kirjeldus | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Nutikas asukoht | Enable movement-based broadcasting | +| Määratud asukoht | Use a manually set position | + +### Toite sätted + +| Setting | Kirjeldus | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Võrgu sätted + +| Setting | Kirjeldus | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Sinihamba sätted + +| Setting | Kirjeldus | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fikseeritud PIN | PIN code for pairing (default: 123456) | + +### Turva sätted + +| Setting | Kirjeldus | +| --------------------- | -------------------------------------------------------------------------- | +| Avalik võti | Your node's public key (read-only) | +| Administraatori võti | Key for remote administration | +| Salajane võti | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Hallatud režiim | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/et-rEE/user/signal-meter.md b/docs/et-rEE/user/signal-meter.md new file mode 100644 index 000000000..12ad7a9d9 --- /dev/null +++ b/docs/et-rEE/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| -------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Hea | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Rahuldav | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Halb | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Puudub | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/et-rEE/user/tak.md b/docs/et-rEE/user/tak.md new file mode 100644 index 000000000..7b7fe56ff --- /dev/null +++ b/docs/et-rEE/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Sätted + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Kirjeldus | +| ------- | -------------------------- | +| Lubatud | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Roll | Kirjeldus | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Kirjeldus | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Roll | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/et-rEE/user/telemetry-and-sensors.md b/docs/et-rEE/user/telemetry-and-sensors.md new file mode 100644 index 000000000..e5391eafc --- /dev/null +++ b/docs/et-rEE/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Kirjeldus | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Vool | Battery voltage | 3.0–4.2V (LiPo) | +| Kanali kasutus | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Töötamise aeg | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Andur | Temperatuur | Niiskus | Õhurõhk | Sõnumid | +| ------- | ----------- | ------- | ------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Andur | Metric | Sõnumid | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Andur | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Võimsusnäitajad + +Nodes with INA-series power sensors can report: + +| Metric | Kirjeldus | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Pinge | Power consumption (mA) | +| Toide | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/et-rEE/user/translate.md b/docs/et-rEE/user/translate.md new file mode 100644 index 000000000..8820091ed --- /dev/null +++ b/docs/et-rEE/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Sõnumid | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/et-rEE/user/units-and-locale.md b/docs/et-rEE/user/units-and-locale.md new file mode 100644 index 000000000..5eec071ed --- /dev/null +++ b/docs/et-rEE/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatuur + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Kõrgus | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Kiirus + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Tuul + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiatsioon | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/fi-rFI/index.md b/docs/fi-rFI/index.md new file mode 100644 index 000000000..fbb78839d --- /dev/null +++ b/docs/fi-rFI/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Kuvaus | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/fi-rFI/user/connections.md b/docs/fi-rFI/user/connections.md new file mode 100644 index 000000000..2b36e0756 --- /dev/null +++ b/docs/fi-rFI/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Yhteydet +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Yhteydet + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Kuvaus | +| ---- | -------------- | ----------------------------- | +| 🟢 | Yhdistetty | Active radio link established | +| 🟡 | Yhdistetään | Handshake in progress | +| 🔴 | Ei yhdistetty | No active connection | +| ⚪ | Not configured | Ei laitetta valittuna | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Asetukset + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/fi-rFI/user/desktop.md b/docs/fi-rFI/user/desktop.md new file mode 100644 index 000000000..0a3a20578 --- /dev/null +++ b/docs/fi-rFI/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Yleiskatsaus + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Asennus + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Viestit | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Kartta | ✓ | ✓ | Full parity | +| Asetukset | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/fi-rFI/user/discovery.md b/docs/fi-rFI/user/discovery.md new file mode 100644 index 000000000..45ab0308b --- /dev/null +++ b/docs/fi-rFI/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Haku +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Haku + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Reitinselvitys + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Naapuritieto + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/fi-rFI/user/firmware.md b/docs/fi-rFI/user/firmware.md new file mode 100644 index 000000000..03250a841 --- /dev/null +++ b/docs/fi-rFI/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanava | Kuvaus | +| ------ | ------------------------------------------- | +| Vakaa | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Vianetsintä + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/fi-rFI/user/map-and-waypoints.md b/docs/fi-rFI/user/map-and-waypoints.md new file mode 100644 index 000000000..36355bd2d --- /dev/null +++ b/docs/fi-rFI/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| --------- | ---------------------------------------------- | +| Vihreä | Online (heard recently) | +| Keltainen | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Sininen | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Kuvaus | +| ---------- | ------------------------------------------------------- | +| Nimi | Short identifier (max 30 characters) | +| Kuvaus | Optional longer description | +| Icon | Visual marker emoji on the map | +| Lukittu | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/fi-rFI/user/messages-and-channels.md b/docs/fi-rFI/user/messages-and-channels.md new file mode 100644 index 000000000..df1c78bc1 --- /dev/null +++ b/docs/fi-rFI/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanavat + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Kanavan turvallisuus + +Channels support multiple encryption levels: + +| Icon | Security Level | Kuvaus | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Yksityisviestit + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Toimitettu | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Virhe | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Virhe | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Aikakatkaisu | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Ei Käyttöliittymää | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Ei Kanavaa | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Ei vastausta | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Virheellinen pyyntö | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/fi-rFI/user/mqtt.md b/docs/fi-rFI/user/mqtt.md new file mode 100644 index 000000000..4818e7d3b --- /dev/null +++ b/docs/fi-rFI/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Yleiskatsaus + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Asetukset + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Kuvaus | Oletus | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Käyttäjänimi | Broker authentication | meshdev | +| Salasana | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Salaus | Encrypt MQTT payload | Käytössä | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Kuvaus | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Kuvaus | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Vianetsintä + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/fi-rFI/user/node-metrics.md b/docs/fi-rFI/user/node-metrics.md new file mode 100644 index 000000000..49b4f2842 --- /dev/null +++ b/docs/fi-rFI/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Laitteen mittausloki + +Basic operating information reported by each node: + +| Metrijärjestelmä | Kuvaus | +| ---------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Jännite | Battery voltage reading | +| Kanavan Käyttö | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Käyttöaika | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Ympäristöarvot + +Environmental sensor data (requires compatible hardware): + +| Metrijärjestelmä | Sensor Examples | +| ------------------------------------ | --------------------- | +| Lämpötila | BME280, BME680, SHT31 | +| Kosteus | BME280, BME680, SHT31 | +| Barometrinen paine | BME280, BMP280 | +| Kaasuvastus | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signaalin voimakkuudet + +Radio signal quality information: + +| Metrijärjestelmä | Kuvaus | +| ---------------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ----------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Hyvä | +| -10 to 0 dB | Kohtalainen | +| < -10 dB | Poor | + +## Virranhallinnan arvot + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metrijärjestelmä | Kuvaus | +| ---------------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Virta | Power draw in milliamps | +| Virta | Calculated wattage | + +## Reitinselvitys + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Sijainnin Loki + +Historical position data for nodes that share their location: + +- GPS coordinates +- Korkeus +- Speed (if moving) +- Timestamp for each position report + +## Naapuritieto + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/fi-rFI/user/nodes.md b/docs/fi-rFI/user/nodes.md new file mode 100644 index 000000000..f389094ea --- /dev/null +++ b/docs/fi-rFI/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Laitteet +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Laitteet + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Rooli | Kuvaus | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Näytä kartalla + - Pyydä sijaintia + - Mark as favorite + - Reitinselvitys + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Suodatus | Kuvaus | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Kuvaus | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| --------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Akun varaus | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Viimeksi kuultu | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Etäisyys | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/fi-rFI/user/onboarding.md b/docs/fi-rFI/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/fi-rFI/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/fi-rFI/user/settings-module-admin.md b/docs/fi-rFI/user/settings-module-admin.md new file mode 100644 index 000000000..e6a061430 --- /dev/null +++ b/docs/fi-rFI/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Kuvaus | +| --------------- | ------------------------------------------------------------------------ | +| Käytössä | Toggle MQTT bridge | +| Palvelin | MQTT broker address | +| Käyttäjänimi | Authentication username | +| Salasana | Authentication password | +| Salaus | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Kuvaus | +| ----------------- | ------------------------------- | +| Käytössä | Activate serial communication | +| Toista | Echo received serial data back | +| Tila | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud-siirtonopeus | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Kuvaus | +| -------------------------------- | --------------------------- | +| Käytössä | Activate notifications | +| Hälytysviesti | Notify on incoming messages | +| Hälytysviestin summeri | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Hälytysääni | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Käytössä | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Kuvaus | +| ------------------------------------------ | -------------------------- | +| Käytössä | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Tiedot | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Kuvaus | +| -------------------------------------- | --------------------------------- | +| Käytössä | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Kuvaus | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Ilmanlaatu käytössä | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Kuvaus | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Viestit | Newline-separated list of messages | +| Lähetä äänimerkki | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Kuvaus | +| --------------- | -------------------------------- | +| Käytössä | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Kuvaus | +| -------------------- | --------------------------------------------------------------- | +| Käytössä | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Kuvaus | +| -------------------------------------- | ------------------------------------ | +| Käytössä | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Kuvaus | +| ------------------ | ---------------------------------------------------------- | +| Käytössä | Activate LED control | +| Ledin tila | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Kuvaus | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Käytössä | Activate detection sensor | +| Valvonta pinni | GPIO pin connected to sensor | +| Havaitsemisen tunnistus korkea | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Lähetä äänimerkki | Include bell character in alerts | +| Käyttäjäystävälinen nimi | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Kuvaus | +| -------------------------------------- | -------------------------- | +| Käytössä | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Ylläpito + +### Etähallinta + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Tyhjennä NodeDB-tietokanta + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Käynnistä uudelleen + +Remotely reboot a connected or administered node. + +### Vianetsintäpaneeli + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/fi-rFI/user/settings-radio-user.md b/docs/fi-rFI/user/settings-radio-user.md new file mode 100644 index 000000000..97fdec129 --- /dev/null +++ b/docs/fi-rFI/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - asetukset + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## Käyttäjäasetukset + +### User Profile + +| Setting | Kuvaus | +| ----------------- | ------------------------------------------------------------------------------------- | +| Pitkä nimi | Your display name (up to 39 characters) | +| Lyhytnimi | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Laitteen asetukset + +| Setting | Kuvaus | Oletus | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Rooli | Node behavior (Client, Router, etc.) | Client | +| Uudelleenlähetyksen tila | How the node retransmits messages | Kaikki | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa:n asetukset + +| Setting | Kuvaus | Oletus | +| ------------------ | ----------------------------------------------------------------------- | ----------------------------------------- | +| Alue | Regulatory region for frequency bands | Unset (must configure) | +| Modeemin esiasetus | Speed/range tradeoff | LongFast | +| Hyppyraja | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Taajuuspoikkeama | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Nopeus | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Näytön asetukset + +| Setting | Kuvaus | +| ------------------- | ------------------------------------------------------------------------------------ | +| Näytön aikakatkaisu | Time before display sleeps | +| Näyttöyksiköt | Metric or Imperial | +| OLED-tyyppi | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Sijainnin asetukset + +| Setting | Kuvaus | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS-päivitysväli | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Älykäs sijainti | Enable movement-based broadcasting | +| Kiinteä sijainti | Use a manually set position | + +### Virran asetukset + +| Setting | Kuvaus | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Verkon asetukset + +| Setting | Kuvaus | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Verkon salasana | +| NTP-palvelin | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth asetukset + +| Setting | Kuvaus | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Kiinteä PIN-koodi | PIN code for pairing (default: 123456) | + +### Turvallisuusasetukset + +| Setting | Kuvaus | +| --------------------- | -------------------------------------------------------------------------- | +| Julkinen avain | Your node's public key (read-only) | +| Ylläpitäjän avain | Key for remote administration | +| Yksityinen avain | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Hallintatila | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/fi-rFI/user/signal-meter.md b/docs/fi-rFI/user/signal-meter.md new file mode 100644 index 000000000..264c3ba07 --- /dev/null +++ b/docs/fi-rFI/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Hyvä | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Kohtalainen | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Huono | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| ei mitään | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/fi-rFI/user/tak.md b/docs/fi-rFI/user/tak.md new file mode 100644 index 000000000..33edc4961 --- /dev/null +++ b/docs/fi-rFI/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Yleiskatsaus + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Edellytykset + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Asetukset + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Kuvaus | +| -------- | -------------------------- | +| Käytössä | Activate TAK interop | +| Tila | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Rooli | Kuvaus | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Kuvaus | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Rooli | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Ominaisuudet | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Vianetsintä + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/fi-rFI/user/telemetry-and-sensors.md b/docs/fi-rFI/user/telemetry-and-sensors.md new file mode 100644 index 000000000..c1410e4f1 --- /dev/null +++ b/docs/fi-rFI/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Yleiskatsaus + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metrijärjestelmä | Kuvaus | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Jännite | Battery voltage | 3.0–4.2V (LiPo) | +| Kanavan Käyttö | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Käyttöaika | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Lämpötila | Kosteus | Ilmanpaine | Viestit | +| ------- | --------- | ------- | ---------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metrijärjestelmä | Viestit | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metrijärjestelmä | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Virranhallinnan arvot + +Nodes with INA-series power sensors can report: + +| Metrijärjestelmä | Kuvaus | +| ---------------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Virta | Power consumption (mA) | +| Virta | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Vianetsintä + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/fi-rFI/user/translate.md b/docs/fi-rFI/user/translate.md new file mode 100644 index 000000000..7ab9c7b2c --- /dev/null +++ b/docs/fi-rFI/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Viestit | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/fi-rFI/user/units-and-locale.md b/docs/fi-rFI/user/units-and-locale.md new file mode 100644 index 000000000..0ab36af44 --- /dev/null +++ b/docs/fi-rFI/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Lämpötila + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Korkeus | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metrijärjestelmä | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Nopeus + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrijärjestelmä | 12 km/h | +| Imperial (US) | 7 mph | + +## Tuuli + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrijärjestelmä | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metrijärjestelmä | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Säteily | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/fr-rFR/index.md b/docs/fr-rFR/index.md new file mode 100644 index 000000000..b38b80d74 --- /dev/null +++ b/docs/fr-rFR/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Description | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/fr-rFR/user/connections.md b/docs/fr-rFR/user/connections.md new file mode 100644 index 000000000..f8df0ccc9 --- /dev/null +++ b/docs/fr-rFR/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connexions +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connexions + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Description | +| ---- | ------------------ | ----------------------------- | +| 🟢 | Connecté | Active radio link established | +| 🟡 | Connexion en cours | Handshake in progress | +| 🔴 | Déconnecté | No active connection | +| ⚪ | Not configured | Aucun appareil sélectionné | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/fr-rFR/user/desktop.md b/docs/fr-rFR/user/desktop.md new file mode 100644 index 000000000..5763e63e9 --- /dev/null +++ b/docs/fr-rFR/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Carte | ✓ | ✓ | Full parity | +| Réglages | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/fr-rFR/user/discovery.md b/docs/fr-rFR/user/discovery.md new file mode 100644 index 000000000..67d779927 --- /dev/null +++ b/docs/fr-rFR/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Découverte +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Découverte + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informations sur les voisins + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/fr-rFR/user/firmware.md b/docs/fr-rFR/user/firmware.md new file mode 100644 index 000000000..4d29a308f --- /dev/null +++ b/docs/fr-rFR/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canal | Description | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/fr-rFR/user/map-and-waypoints.md b/docs/fr-rFR/user/map-and-waypoints.md new file mode 100644 index 000000000..cefdbebbd --- /dev/null +++ b/docs/fr-rFR/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ----- | ---------------------------------------------- | +| Vert | Online (heard recently) | +| Jaune | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Bleu | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Description | +| ----------- | ------------------------------------------------------- | +| Nom | Short identifier (max 30 characters) | +| Description | Optional longer description | +| Icon | Visual marker emoji on the map | +| Verrouillé | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/fr-rFR/user/messages-and-channels.md b/docs/fr-rFR/user/messages-and-channels.md new file mode 100644 index 000000000..77915486b --- /dev/null +++ b/docs/fr-rFR/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Canaux + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Sécurité du canal + +Channels support multiple encryption levels: + +| Icon | Security Level | Description | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Messages directs + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Distribué | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Erreur | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Erreur | Meaning | What to Do | +| ------------------------------ | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Pas de route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Délai d'expiration | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Pas d'interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Pas de canal ou d'autorisation | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Pas de réponse | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Mauvaise requête | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/fr-rFR/user/mqtt.md b/docs/fr-rFR/user/mqtt.md new file mode 100644 index 000000000..f3a6467b7 --- /dev/null +++ b/docs/fr-rFR/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Description | Par défaut | +| ----------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Nom d'utilisateur | Broker authentication | meshdev | +| Mot de passe | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Chiffrement | Encrypt MQTT payload | Activé | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Désactivé | +| TLS | Secure connection to broker | Désactivé | +| Map Reporting | Report position to public map | Désactivé | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Description | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Description | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/fr-rFR/user/node-metrics.md b/docs/fr-rFR/user/node-metrics.md new file mode 100644 index 000000000..a8bbbbf21 --- /dev/null +++ b/docs/fr-rFR/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Métriques de l’appareil + +Basic operating information reported by each node: + +| Metric | Description | +| ----------------------- | ----------------------------------- | +| Niveau de batterie | Current battery percentage | +| Tension | Battery voltage reading | +| Utilisation du canal | Percentage of airtime consumed | +| Temps d'émission | Transmission time used by this node | +| Durée de fonctionnement | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Métriques d'environnement + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Température | BME280, BME680, SHT31 | +| Humidité | BME280, BME680, SHT31 | +| Pression Barométrique | BME280, BMP280 | +| Résistance au gaz | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Métriques de Signal + +Radio signal quality information: + +| Metric | Description | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Bon | +| -10 to 0 dB | Passable | +| < -10 dB | Poor | + +## Métriques d'alimentation + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Description | +| ------------ | ----------------------- | +| Bus Voltage | Supply voltage | +| Actif | Power draw in milliamps | +| Alimentation | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Journal des positions + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Informations sur les voisins + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/fr-rFR/user/nodes.md b/docs/fr-rFR/user/nodes.md new file mode 100644 index 000000000..6f1b811e5 --- /dev/null +++ b/docs/fr-rFR/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nœuds +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nœuds + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Rôle | Description | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Base Client | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client muet | Receives but doesn't retransmit | +| Client masqué | Like Client Mute, plus hides from node list | +| Routeur | Prioritizes message forwarding; stays awake to relay | +| Routeur avec retard | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Traqueur | Optimized for position reporting at regular intervals | +| Capteur | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| Traqueur TAK | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Afficher sur la carte + - Demander la position + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtre | Description | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Description | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ------------------ | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Niveau de batterie | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Dernière écoute | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distance | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/fr-rFR/user/onboarding.md b/docs/fr-rFR/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/fr-rFR/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/fr-rFR/user/settings-module-admin.md b/docs/fr-rFR/user/settings-module-admin.md new file mode 100644 index 000000000..56f458ea5 --- /dev/null +++ b/docs/fr-rFR/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Configuration du module + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Description | +| ----------------- | ------------------------------------------------------------------------ | +| Activé | Toggle MQTT bridge | +| Serveur | MQTT broker address | +| Nom d'utilisateur | Authentication username | +| Mot de passe | Authentication password | +| Chiffrement | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Description | +| ---------------- | ------------------------------- | +| Activé | Activate serial communication | +| Écho | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Vitesse en bauds | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Description | +| -------------------------------- | --------------------------- | +| Activé | Activate notifications | +| Message d'alerte | Notify on incoming messages | +| Message d'alerte buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Bip d'alerte | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Actif | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Description | +| ------------------------------------------ | -------------------------- | +| Activé | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Enregistrements | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Description | +| -------------------------------------- | --------------------------------- | +| Activé | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Description | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Qualité de l'air activée | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Description | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Envoyer un bip | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Description | +| --------------- | -------------------------------- | +| Activé | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Description | +| -------------------- | --------------------------------------------------------------- | +| Activé | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Description | +| -------------------------------------- | ------------------------------------ | +| Activé | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Description | +| ------------------ | ---------------------------------------------------------- | +| Activé | Activate LED control | +| État des LED | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Description | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Activé | Activate detection sensor | +| Broche de monitoring | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Envoyer un bip | Include bell character in alerts | +| Nom convivial | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Description | +| -------------------------------------- | -------------------------- | +| Activé | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Administration à distance + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Nettoyer la base de données des nœuds + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Redémarrer + +Remotely reboot a connected or administered node. + +### Panneau de débogage + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/fr-rFR/user/settings-radio-user.md b/docs/fr-rFR/user/settings-radio-user.md new file mode 100644 index 000000000..1b5a663cf --- /dev/null +++ b/docs/fr-rFR/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - paramètres + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## Paramètres utilisateur + +### User Profile + +| Setting | Description | +| ----------------- | ------------------------------------------------------------------------------------- | +| Nom long | Your display name (up to 39 characters) | +| Nom court | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Configuration de la radio + +### Configuration de l'appareil + +| Setting | Description | Par défaut | +| ------------------------------------------ | ----------------------------------------------------------------------- | ---------- | +| Rôle | Node behavior (Client, Router, etc.) | Client | +| Mode de réémission | How the node retransmits messages | Tout | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Désactivé | + +### Configuration LoRa + +| Setting | Description | Par défaut | +| --------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Région | Regulatory region for frequency bands | Unset (must configure) | +| Préréglage du modem | Speed/range tradeoff | LongFast | +| Limite de sauts | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Décalage de fréquence | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Vitesse | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Configuration de l'écran + +| Setting | Description | +| ----------------------------- | ------------------------------------------------------------------------------------ | +| Délai d'extinction de l'écran | Time before display sleeps | +| Unités affichées | Metric or Imperial | +| Type d'OLED | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Configuration de la position + +| Setting | Description | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| Intervalle de mise à jour GPS | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Position Intelligente | Enable movement-based broadcasting | +| Position fixe | Use a manually set position | + +### Configuration de l'alimentation + +| Setting | Description | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Configuration du réseau + +| Setting | Description | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Mot de passe du réseau | +| Serveur NTP | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Configuration Bluetooth + +| Setting | Description | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Mode d'appairage | Fixed PIN, Random PIN, or No PIN | +| Code PIN fixe | PIN code for pairing (default: 123456) | + +### Configuration de sécurité + +| Setting | Description | +| --------------------- | -------------------------------------------------------------------------- | +| Clé publique | Your node's public key (read-only) | +| Clé Admin | Key for remote administration | +| Clé privée | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Mode géré | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/fr-rFR/user/signal-meter.md b/docs/fr-rFR/user/signal-meter.md new file mode 100644 index 000000000..e0b83f0f9 --- /dev/null +++ b/docs/fr-rFR/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| -------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Bon | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Passable | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Mauvais | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Aucun | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/fr-rFR/user/tak.md b/docs/fr-rFR/user/tak.md new file mode 100644 index 000000000..8439d5925 --- /dev/null +++ b/docs/fr-rFR/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Description | +| ------- | -------------------------- | +| Activé | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Rôle | Description | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Description | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Rôle | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/fr-rFR/user/telemetry-and-sensors.md b/docs/fr-rFR/user/telemetry-and-sensors.md new file mode 100644 index 000000000..598d8661d --- /dev/null +++ b/docs/fr-rFR/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Description | Typical Range | +| ----------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Niveau de batterie | Charge percentage | 0–100% | +| Tension | Battery voltage | 3.0–4.2V (LiPo) | +| Utilisation du canal | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Durée de fonctionnement | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Capteur | Température | Humidité | Pression | Notes | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Capteur | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Capteur | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Métriques d'alimentation + +Nodes with INA-series power sensors can report: + +| Metric | Description | +| ------------ | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Actif | Power consumption (mA) | +| Alimentation | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/fr-rFR/user/translate.md b/docs/fr-rFR/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/fr-rFR/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/fr-rFR/user/units-and-locale.md b/docs/fr-rFR/user/units-and-locale.md new file mode 100644 index 000000000..b0c7ce7a9 --- /dev/null +++ b/docs/fr-rFR/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Température + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Vitesse + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Vent + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/ga-rIE/index.md b/docs/ga-rIE/index.md new file mode 100644 index 000000000..e53086c23 --- /dev/null +++ b/docs/ga-rIE/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Cur síos | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/ga-rIE/user/connections.md b/docs/ga-rIE/user/connections.md new file mode 100644 index 000000000..f2b94131c --- /dev/null +++ b/docs/ga-rIE/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Cur síos | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Na ceangailte | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ga-rIE/user/desktop.md b/docs/ga-rIE/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/ga-rIE/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ga-rIE/user/discovery.md b/docs/ga-rIE/user/discovery.md new file mode 100644 index 000000000..018179d60 --- /dev/null +++ b/docs/ga-rIE/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Céim rianadóireachta + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ga-rIE/user/firmware.md b/docs/ga-rIE/user/firmware.md new file mode 100644 index 000000000..c770115f0 --- /dev/null +++ b/docs/ga-rIE/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Cainéal | Cur síos | +| ------- | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ga-rIE/user/map-and-waypoints.md b/docs/ga-rIE/user/map-and-waypoints.md new file mode 100644 index 000000000..f76aa28bd --- /dev/null +++ b/docs/ga-rIE/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Cur síos | +| ---------- | ------------------------------------------------------- | +| Ainm | Short identifier (max 30 characters) | +| Cur síos | Optional longer description | +| Icon | Visual marker emoji on the map | +| Ceangailte | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ga-rIE/user/messages-and-channels.md b/docs/ga-rIE/user/messages-and-channels.md new file mode 100644 index 000000000..4b4ab36f9 --- /dev/null +++ b/docs/ga-rIE/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Cur síos | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Earráid | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Earráid | Meaning | What to Do | +| ----------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Am tráth | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Gan anicéir | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Gan cainéal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Iarratas Mícheart | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ga-rIE/user/mqtt.md b/docs/ga-rIE/user/mqtt.md new file mode 100644 index 000000000..588dad955 --- /dev/null +++ b/docs/ga-rIE/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Cur síos | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Cur síos | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Cur síos | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ga-rIE/user/node-metrics.md b/docs/ga-rIE/user/node-metrics.md new file mode 100644 index 000000000..a68bcb4ff --- /dev/null +++ b/docs/ga-rIE/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Cur síos | +| ------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Úsáid cainéil | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Teocht | BME280, BME680, SHT31 | +| Laige | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Cur síos | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ------------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Maith | +| -10 to 0 dB | Ceart go leor | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Cur síos | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Céim rianadóireachta + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Lógáil Seirbhís + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ga-rIE/user/nodes.md b/docs/ga-rIE/user/nodes.md new file mode 100644 index 000000000..50b4b386f --- /dev/null +++ b/docs/ga-rIE/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Cur síos | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Iarr an suíomh + - Mark as favorite + - Céim rianadóireachta + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Scagaire | Cur síos | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Cur síos | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ----------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Deiridh chluinmhu | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Sáth | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ga-rIE/user/onboarding.md b/docs/ga-rIE/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ga-rIE/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ga-rIE/user/settings-module-admin.md b/docs/ga-rIE/user/settings-module-admin.md new file mode 100644 index 000000000..a6daa30df --- /dev/null +++ b/docs/ga-rIE/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Cur síos | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Cur síos | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Cur síos | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Cur síos | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Cur síos | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Cur síos | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Cur síos | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Cur síos | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Cur síos | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Cur síos | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Cur síos | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Cur síos | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Cur síos | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Rialachas + +### Rialú iargúlta + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Athmhaoinigh + +Remotely reboot a connected or administered node. + +### Painéal Laige + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ga-rIE/user/settings-radio-user.md b/docs/ga-rIE/user/settings-radio-user.md new file mode 100644 index 000000000..34c15a118 --- /dev/null +++ b/docs/ga-rIE/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Cur síos | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Cur síos | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Cur síos | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Réigiún | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Cur síos | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Cur síos | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Cur síos | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Cur síos | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Cur síos | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Cur síos | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ga-rIE/user/signal-meter.md b/docs/ga-rIE/user/signal-meter.md new file mode 100644 index 000000000..5ecbac53c --- /dev/null +++ b/docs/ga-rIE/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ---------------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Maith | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Ceart go leor | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Go dona | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Ní dhéanfaidh sé | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ga-rIE/user/tak.md b/docs/ga-rIE/user/tak.md new file mode 100644 index 000000000..cb7f3556e --- /dev/null +++ b/docs/ga-rIE/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Cur síos | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Cur síos | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Cur síos | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ga-rIE/user/telemetry-and-sensors.md b/docs/ga-rIE/user/telemetry-and-sensors.md new file mode 100644 index 000000000..08eece8ca --- /dev/null +++ b/docs/ga-rIE/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Cur síos | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Úsáid cainéil | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Teocht | Laige | Pressure | Notes | +| ------- | ------ | ----- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Cur síos | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ga-rIE/user/translate.md b/docs/ga-rIE/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/ga-rIE/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/ga-rIE/user/units-and-locale.md b/docs/ga-rIE/user/units-and-locale.md new file mode 100644 index 000000000..ccc096398 --- /dev/null +++ b/docs/ga-rIE/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Teocht + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/gl-rES/index.md b/docs/gl-rES/index.md new file mode 100644 index 000000000..b1195bbe1 --- /dev/null +++ b/docs/gl-rES/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Descrición | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/gl-rES/user/connections.md b/docs/gl-rES/user/connections.md new file mode 100644 index 000000000..09ef87f8b --- /dev/null +++ b/docs/gl-rES/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Descrición | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Desconectado | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/gl-rES/user/desktop.md b/docs/gl-rES/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/gl-rES/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/gl-rES/user/discovery.md b/docs/gl-rES/user/discovery.md new file mode 100644 index 000000000..5a0bfd9b8 --- /dev/null +++ b/docs/gl-rES/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traza-ruta + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/gl-rES/user/firmware.md b/docs/gl-rES/user/firmware.md new file mode 100644 index 000000000..98352def3 --- /dev/null +++ b/docs/gl-rES/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canle | Descrición | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/gl-rES/user/map-and-waypoints.md b/docs/gl-rES/user/map-and-waypoints.md new file mode 100644 index 000000000..4edb3dade --- /dev/null +++ b/docs/gl-rES/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Descrición | +| ---------- | ------------------------------------------------------- | +| Nome | Short identifier (max 30 characters) | +| Descrición | Optional longer description | +| Icon | Visual marker emoji on the map | +| Bloqueado | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/gl-rES/user/messages-and-channels.md b/docs/gl-rES/user/messages-and-channels.md new file mode 100644 index 000000000..925f2f460 --- /dev/null +++ b/docs/gl-rES/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Descrición | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Erro | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Erro | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| No Interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| No Channel | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Bad Request | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/gl-rES/user/mqtt.md b/docs/gl-rES/user/mqtt.md new file mode 100644 index 000000000..706efec5d --- /dev/null +++ b/docs/gl-rES/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descrición | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Descrición | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Descrición | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/gl-rES/user/node-metrics.md b/docs/gl-rES/user/node-metrics.md new file mode 100644 index 000000000..02f434faa --- /dev/null +++ b/docs/gl-rES/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Descrición | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperature | BME280, BME680, SHT31 | +| Humidity | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Descrición | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Good | +| -10 to 0 dB | Fair | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Descrición | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Traza-ruta + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Log + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/gl-rES/user/nodes.md b/docs/gl-rES/user/nodes.md new file mode 100644 index 000000000..7face2672 --- /dev/null +++ b/docs/gl-rES/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Descrición | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Cliente | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Solicitar posición + - Mark as favorite + - Traza-ruta + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtro | Descrición | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Descrición | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Última escoita | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distancia | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/gl-rES/user/onboarding.md b/docs/gl-rES/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/gl-rES/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/gl-rES/user/settings-module-admin.md b/docs/gl-rES/user/settings-module-admin.md new file mode 100644 index 000000000..8db6dc95b --- /dev/null +++ b/docs/gl-rES/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Descrición | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Descrición | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Descrición | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Descrición | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Descrición | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Descrición | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Descrición | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Descrición | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Descrición | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Descrición | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Descrición | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Descrición | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Descrición | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Remote Administration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Reiniciar + +Remotely reboot a connected or administered node. + +### Panel de depuración + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/gl-rES/user/settings-radio-user.md b/docs/gl-rES/user/settings-radio-user.md new file mode 100644 index 000000000..b555f6b93 --- /dev/null +++ b/docs/gl-rES/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Descrición | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Descrición | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Cliente | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Descrición | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Rexión | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Descrición | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Descrición | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Descrición | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Descrición | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Descrición | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Descrición | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/gl-rES/user/signal-meter.md b/docs/gl-rES/user/signal-meter.md new file mode 100644 index 000000000..d34246d0e --- /dev/null +++ b/docs/gl-rES/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Good | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Fair | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Bad | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| None | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/gl-rES/user/tak.md b/docs/gl-rES/user/tak.md new file mode 100644 index 000000000..1e81a2a78 --- /dev/null +++ b/docs/gl-rES/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descrición | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Descrición | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Descrición | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/gl-rES/user/telemetry-and-sensors.md b/docs/gl-rES/user/telemetry-and-sensors.md new file mode 100644 index 000000000..ffa24994d --- /dev/null +++ b/docs/gl-rES/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Descrición | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperature | Humidity | Pressure | Notes | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Descrición | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/gl-rES/user/translate.md b/docs/gl-rES/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/gl-rES/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/gl-rES/user/units-and-locale.md b/docs/gl-rES/user/units-and-locale.md new file mode 100644 index 000000000..5f391111d --- /dev/null +++ b/docs/gl-rES/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperature + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/hr-rHR/index.md b/docs/hr-rHR/index.md new file mode 100644 index 000000000..0cb3c90e2 --- /dev/null +++ b/docs/hr-rHR/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Opis | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/hr-rHR/user/connections.md b/docs/hr-rHR/user/connections.md new file mode 100644 index 000000000..b7c3bd763 --- /dev/null +++ b/docs/hr-rHR/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Opis | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Odspojeno | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/hr-rHR/user/desktop.md b/docs/hr-rHR/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/hr-rHR/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/hr-rHR/user/discovery.md b/docs/hr-rHR/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/hr-rHR/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/hr-rHR/user/firmware.md b/docs/hr-rHR/user/firmware.md new file mode 100644 index 000000000..28f6705bf --- /dev/null +++ b/docs/hr-rHR/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Opis | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/hr-rHR/user/map-and-waypoints.md b/docs/hr-rHR/user/map-and-waypoints.md new file mode 100644 index 000000000..964d1b31a --- /dev/null +++ b/docs/hr-rHR/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Opis | +| ---------- | ------------------------------------------------------- | +| Ime | Short identifier (max 30 characters) | +| Opis | Optional longer description | +| Icon | Visual marker emoji on the map | +| Zaključano | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/hr-rHR/user/messages-and-channels.md b/docs/hr-rHR/user/messages-and-channels.md new file mode 100644 index 000000000..89981caf9 --- /dev/null +++ b/docs/hr-rHR/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Opis | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Pogreška | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Pogreška | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| No Interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| No Channel | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Bad Request | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/hr-rHR/user/mqtt.md b/docs/hr-rHR/user/mqtt.md new file mode 100644 index 000000000..742337e4f --- /dev/null +++ b/docs/hr-rHR/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Opis | Zadano | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Opis | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Opis | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/hr-rHR/user/node-metrics.md b/docs/hr-rHR/user/node-metrics.md new file mode 100644 index 000000000..a05c3d408 --- /dev/null +++ b/docs/hr-rHR/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Opis | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperature | BME280, BME680, SHT31 | +| Humidity | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Opis | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Good | +| -10 to 0 dB | Fair | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Opis | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Log + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/hr-rHR/user/nodes.md b/docs/hr-rHR/user/nodes.md new file mode 100644 index 000000000..cca4841b4 --- /dev/null +++ b/docs/hr-rHR/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Opis | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Zatraži poziciju + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtriraj | Opis | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Opis | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Posljednje čuo | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Udaljenost | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/hr-rHR/user/onboarding.md b/docs/hr-rHR/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/hr-rHR/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/hr-rHR/user/settings-module-admin.md b/docs/hr-rHR/user/settings-module-admin.md new file mode 100644 index 000000000..4178a1543 --- /dev/null +++ b/docs/hr-rHR/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Opis | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Opis | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Opis | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Opis | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Opis | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Opis | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Opis | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Opis | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Opis | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Opis | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Opis | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Opis | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Opis | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Remote Administration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Ponovno pokreni + +Remotely reboot a connected or administered node. + +### Otklanjanje pogrešaka + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/hr-rHR/user/settings-radio-user.md b/docs/hr-rHR/user/settings-radio-user.md new file mode 100644 index 000000000..7e59ec899 --- /dev/null +++ b/docs/hr-rHR/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Opis | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Opis | Zadano | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Opis | Zadano | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regija | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Opis | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Opis | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Opis | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Opis | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Postavke Bluetootha + +| Setting | Opis | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Opis | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/hr-rHR/user/signal-meter.md b/docs/hr-rHR/user/signal-meter.md new file mode 100644 index 000000000..d34246d0e --- /dev/null +++ b/docs/hr-rHR/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Good | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Fair | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Bad | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| None | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/hr-rHR/user/tak.md b/docs/hr-rHR/user/tak.md new file mode 100644 index 000000000..f7736efe0 --- /dev/null +++ b/docs/hr-rHR/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Opis | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Opis | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Opis | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/hr-rHR/user/telemetry-and-sensors.md b/docs/hr-rHR/user/telemetry-and-sensors.md new file mode 100644 index 000000000..07aa1c1c4 --- /dev/null +++ b/docs/hr-rHR/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Opis | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperature | Humidity | Pressure | Notes | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Opis | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/hr-rHR/user/translate.md b/docs/hr-rHR/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/hr-rHR/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/hr-rHR/user/units-and-locale.md b/docs/hr-rHR/user/units-and-locale.md new file mode 100644 index 000000000..5f391111d --- /dev/null +++ b/docs/hr-rHR/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperature + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/ht-rHT/index.md b/docs/ht-rHT/index.md new file mode 100644 index 000000000..a9c75570d --- /dev/null +++ b/docs/ht-rHT/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Deskripsyon | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/ht-rHT/user/connections.md b/docs/ht-rHT/user/connections.md new file mode 100644 index 000000000..6c093f52c --- /dev/null +++ b/docs/ht-rHT/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Deskripsyon | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Dekonekte | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ht-rHT/user/desktop.md b/docs/ht-rHT/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/ht-rHT/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ht-rHT/user/discovery.md b/docs/ht-rHT/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/ht-rHT/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ht-rHT/user/firmware.md b/docs/ht-rHT/user/firmware.md new file mode 100644 index 000000000..613df9f53 --- /dev/null +++ b/docs/ht-rHT/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| kanal | Deskripsyon | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ht-rHT/user/map-and-waypoints.md b/docs/ht-rHT/user/map-and-waypoints.md new file mode 100644 index 000000000..7d0ee6841 --- /dev/null +++ b/docs/ht-rHT/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Deskripsyon | +| ----------- | ------------------------------------------------------- | +| Non | Short identifier (max 30 characters) | +| Deskripsyon | Optional longer description | +| Icon | Visual marker emoji on the map | +| Loken | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ht-rHT/user/messages-and-channels.md b/docs/ht-rHT/user/messages-and-channels.md new file mode 100644 index 000000000..0017c5ca3 --- /dev/null +++ b/docs/ht-rHT/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Deskripsyon | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Erè | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Erè | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Tan pase | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Pa gen entèfas | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Pa gen kanal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Demann move | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ht-rHT/user/mqtt.md b/docs/ht-rHT/user/mqtt.md new file mode 100644 index 000000000..f06047a8a --- /dev/null +++ b/docs/ht-rHT/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Deskripsyon | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Deskripsyon | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Deskripsyon | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ht-rHT/user/node-metrics.md b/docs/ht-rHT/user/node-metrics.md new file mode 100644 index 000000000..3f0548000 --- /dev/null +++ b/docs/ht-rHT/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Deskripsyon | +| ----------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Itilizasyon Kanal | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Tanperati | BME280, BME680, SHT31 | +| Imidite | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Deskripsyon | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Bon | +| -10 to 0 dB | Mwayen | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Deskripsyon | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Jounal Pozisyon + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ht-rHT/user/nodes.md b/docs/ht-rHT/user/nodes.md new file mode 100644 index 000000000..42717af76 --- /dev/null +++ b/docs/ht-rHT/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Deskripsyon | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Mande pozisyon + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtre | Deskripsyon | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Deskripsyon | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ------------------ | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Dènye fwa li tande | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distans | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ht-rHT/user/onboarding.md b/docs/ht-rHT/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ht-rHT/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ht-rHT/user/settings-module-admin.md b/docs/ht-rHT/user/settings-module-admin.md new file mode 100644 index 000000000..be4aa853e --- /dev/null +++ b/docs/ht-rHT/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Deskripsyon | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Deskripsyon | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Deskripsyon | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Deskripsyon | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Deskripsyon | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Deskripsyon | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Deskripsyon | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Deskripsyon | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Deskripsyon | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Deskripsyon | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Deskripsyon | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Deskripsyon | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Deskripsyon | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administrasyon + +### Administrasyon Remote + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Rekòmanse + +Remotely reboot a connected or administered node. + +### Panno Debug + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ht-rHT/user/settings-radio-user.md b/docs/ht-rHT/user/settings-radio-user.md new file mode 100644 index 000000000..a331b7753 --- /dev/null +++ b/docs/ht-rHT/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Deskripsyon | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Deskripsyon | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Deskripsyon | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Rejyon | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Deskripsyon | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Deskripsyon | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Deskripsyon | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Deskripsyon | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Deskripsyon | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Deskripsyon | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ht-rHT/user/signal-meter.md b/docs/ht-rHT/user/signal-meter.md new file mode 100644 index 000000000..e5ec164a7 --- /dev/null +++ b/docs/ht-rHT/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------ | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Bon | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Mwayen | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Move | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Pa gen | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ht-rHT/user/tak.md b/docs/ht-rHT/user/tak.md new file mode 100644 index 000000000..3c62b4549 --- /dev/null +++ b/docs/ht-rHT/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Deskripsyon | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Deskripsyon | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Deskripsyon | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ht-rHT/user/telemetry-and-sensors.md b/docs/ht-rHT/user/telemetry-and-sensors.md new file mode 100644 index 000000000..436965dcb --- /dev/null +++ b/docs/ht-rHT/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Deskripsyon | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Itilizasyon Kanal | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Tanperati | Imidite | Pressure | Notes | +| ------- | --------- | ------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Deskripsyon | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ht-rHT/user/translate.md b/docs/ht-rHT/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/ht-rHT/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/ht-rHT/user/units-and-locale.md b/docs/ht-rHT/user/units-and-locale.md new file mode 100644 index 000000000..74b74eb6b --- /dev/null +++ b/docs/ht-rHT/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Tanperati + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/hu-rHU/index.md b/docs/hu-rHU/index.md new file mode 100644 index 000000000..646924c27 --- /dev/null +++ b/docs/hu-rHU/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Leírás | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/hu-rHU/user/connections.md b/docs/hu-rHU/user/connections.md new file mode 100644 index 000000000..9f0d50917 --- /dev/null +++ b/docs/hu-rHU/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Leírás | +| ---- | -------------- | ----------------------------- | +| 🟢 | Csatlakoztatva | Active radio link established | +| 🟡 | Csatlakozás… | Handshake in progress | +| 🔴 | Szétkapcsolva | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/hu-rHU/user/desktop.md b/docs/hu-rHU/user/desktop.md new file mode 100644 index 000000000..d252f9b71 --- /dev/null +++ b/docs/hu-rHU/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Jegyzetek | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Térkép | ✓ | ✓ | Full parity | +| Beállítások | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/hu-rHU/user/discovery.md b/docs/hu-rHU/user/discovery.md new file mode 100644 index 000000000..ec0dc1822 --- /dev/null +++ b/docs/hu-rHU/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Szomszéd-információ + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/hu-rHU/user/firmware.md b/docs/hu-rHU/user/firmware.md new file mode 100644 index 000000000..4b8b24cc4 --- /dev/null +++ b/docs/hu-rHU/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Csatorna | Leírás | +| -------- | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/hu-rHU/user/map-and-waypoints.md b/docs/hu-rHU/user/map-and-waypoints.md new file mode 100644 index 000000000..99fae4acd --- /dev/null +++ b/docs/hu-rHU/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Zöld | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Kék | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Leírás | +| ---------- | ------------------------------------------------------- | +| Név | Short identifier (max 30 characters) | +| Leírás | Optional longer description | +| Icon | Visual marker emoji on the map | +| Zárolt | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/hu-rHU/user/messages-and-channels.md b/docs/hu-rHU/user/messages-and-channels.md new file mode 100644 index 000000000..6b0ac38a1 --- /dev/null +++ b/docs/hu-rHU/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Csatornák + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Csatorna biztonság + +Channels support multiple encryption levels: + +| Icon | Security Level | Leírás | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Hiba | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Hiba | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Időtúllépés | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Nincs Interfész | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Nincs Csatorna | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Hibás kérés | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/hu-rHU/user/mqtt.md b/docs/hu-rHU/user/mqtt.md new file mode 100644 index 000000000..8c46e8cd5 --- /dev/null +++ b/docs/hu-rHU/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Leírás | Alapértelmezett | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Felhasználónév | Broker authentication | meshdev | +| Jelszó | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Engedélyezve | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Leírás | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Leírás | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/hu-rHU/user/node-metrics.md b/docs/hu-rHU/user/node-metrics.md new file mode 100644 index 000000000..a16668b4f --- /dev/null +++ b/docs/hu-rHU/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Eszközmetrikák + +Basic operating information reported by each node: + +| Metric | Leírás | +| ----------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Feszültség | Battery voltage reading | +| Csatornahasználat | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Működési idő | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Környezeti metrikák + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Hőmérséklet | BME280, BME680, SHT31 | +| Páratartalom | BME280, BME680, SHT31 | +| Légnyomás | BME280, BMP280 | +| Gázellenállás | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Leírás | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Jó | +| -10 to 0 dB | Megfelelő | +| < -10 dB | Poor | + +## Tápellátási metrikák + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Leírás | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Áramerősség | Power draw in milliamps | +| Energia | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Pozíciónapló + +Historical position data for nodes that share their location: + +- GPS coordinates +- Magasság +- Speed (if moving) +- Timestamp for each position report + +## Szomszéd-információ + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/hu-rHU/user/nodes.md b/docs/hu-rHU/user/nodes.md new file mode 100644 index 000000000..135cc5b66 --- /dev/null +++ b/docs/hu-rHU/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Csomópontok +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Csomópontok + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Szerepkör | Leírás | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Kliens | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Néma Kliens | Receives but doesn't retransmit | +| Rejtett Kliens | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Késő Router | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Szenzor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Megtekintés térképen + - Pozíció kérése + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Leírás | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Leírás | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ---------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Utoljára hallott | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Távolság | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/hu-rHU/user/onboarding.md b/docs/hu-rHU/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/hu-rHU/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/hu-rHU/user/settings-module-admin.md b/docs/hu-rHU/user/settings-module-admin.md new file mode 100644 index 000000000..ce2bbd6aa --- /dev/null +++ b/docs/hu-rHU/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Leírás | +| --------------- | ------------------------------------------------------------------------ | +| Engedélyezve | Toggle MQTT bridge | +| Szerver | MQTT broker address | +| Felhasználónév | Authentication username | +| Jelszó | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Leírás | +| ------------ | ------------------------------- | +| Engedélyezve | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Leírás | +| -------------------------------- | --------------------------- | +| Engedélyezve | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Leírás | +| ------------------------------------------ | -------------------------- | +| Engedélyezve | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Bejegyzések | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Leírás | +| -------------------------------------- | --------------------------------- | +| Engedélyezve | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Leírás | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Leírás | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Üzenetek | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Leírás | +| --------------- | -------------------------------- | +| Engedélyezve | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Leírás | +| -------------------- | --------------------------------------------------------------- | +| Engedélyezve | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Leírás | +| -------------------------------------- | ------------------------------------ | +| Engedélyezve | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Leírás | +| ------------------ | ---------------------------------------------------------- | +| Engedélyezve | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Leírás | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Engedélyezve | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Leírás | +| -------------------------------------- | -------------------------- | +| Engedélyezve | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Adminisztráció + +### Távoli Adminisztráció + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Csomópont-adatbázis tisztítása + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Újraindítás + +Remotely reboot a connected or administered node. + +### Hibakereső panel + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/hu-rHU/user/settings-radio-user.md b/docs/hu-rHU/user/settings-radio-user.md new file mode 100644 index 000000000..f5039fa44 --- /dev/null +++ b/docs/hu-rHU/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - beállítások + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Leírás | +| ----------------- | ------------------------------------------------------------------------------------- | +| Hosszú név | Your display name (up to 39 characters) | +| Rövid név | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Eszközbeállítások + +| Setting | Leírás | Alapértelmezett | +| ------------------------------------------ | ----------------------------------------------------------------------- | --------------- | +| Szerepkör | Node behavior (Client, Router, etc.) | Kliens | +| Újrasugárzási mód | How the node retransmits messages | Összes | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa beállítások + +| Setting | Leírás | Alapértelmezett | +| ------------------ | ----------------------------------------------------------------------- | ----------------------------------------- | +| Régió | Regulatory region for frequency bands | Unset (must configure) | +| Modem-előbeállítás | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Sebesség | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Kijelző beállítások + +| Setting | Leírás | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Pozíció beállítások + +| Setting | Leírás | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Intelligens pozíció | Enable movement-based broadcasting | +| Rögzített pozíció | Use a manually set position | + +### Energia-beállítások + +| Setting | Leírás | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Hálózati beállítások + +| Setting | Leírás | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth beállítások + +| Setting | Leírás | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Rögzített PIN | PIN code for pairing (default: 123456) | + +### Biztonsági beállítások + +| Setting | Leírás | +| --------------------- | -------------------------------------------------------------------------- | +| Nyilvános kulcs | Your node's public key (read-only) | +| Admin kulcs | Key for remote administration | +| Privát kulcs | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Felügyelt mód | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/hu-rHU/user/signal-meter.md b/docs/hu-rHU/user/signal-meter.md new file mode 100644 index 000000000..7e7efabdd --- /dev/null +++ b/docs/hu-rHU/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| --------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Jó | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Megfelelő | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Rossz | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Semmi | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/hu-rHU/user/tak.md b/docs/hu-rHU/user/tak.md new file mode 100644 index 000000000..87e710f4f --- /dev/null +++ b/docs/hu-rHU/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Leírás | +| ------------ | -------------------------- | +| Engedélyezve | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Szerepkör | Leírás | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Leírás | +| --------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Szerepkör | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/hu-rHU/user/telemetry-and-sensors.md b/docs/hu-rHU/user/telemetry-and-sensors.md new file mode 100644 index 000000000..8885aa6d2 --- /dev/null +++ b/docs/hu-rHU/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Leírás | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Feszültség | Battery voltage | 3.0–4.2V (LiPo) | +| Csatornahasználat | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Működési idő | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Szenzor | Hőmérséklet | Páratartalom | Nyomás | Jegyzetek | +| ------- | ----------- | ------------ | ------ | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Szenzor | Metric | Jegyzetek | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Szenzor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Tápellátási metrikák + +Nodes with INA-series power sensors can report: + +| Metric | Leírás | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Áramerősség | Power consumption (mA) | +| Energia | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/hu-rHU/user/translate.md b/docs/hu-rHU/user/translate.md new file mode 100644 index 000000000..806570d55 --- /dev/null +++ b/docs/hu-rHU/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Jegyzetek | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/hu-rHU/user/units-and-locale.md b/docs/hu-rHU/user/units-and-locale.md new file mode 100644 index 000000000..d897d57e5 --- /dev/null +++ b/docs/hu-rHU/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Hőmérséklet + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Magasság | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Sebesség + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Szél + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Sugárzás | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/is-rIS/index.md b/docs/is-rIS/index.md new file mode 100644 index 000000000..39c7824f2 --- /dev/null +++ b/docs/is-rIS/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Lýsing | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/is-rIS/user/connections.md b/docs/is-rIS/user/connections.md new file mode 100644 index 000000000..36d1c28ce --- /dev/null +++ b/docs/is-rIS/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Lýsing | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Aftengd | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/is-rIS/user/desktop.md b/docs/is-rIS/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/is-rIS/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/is-rIS/user/discovery.md b/docs/is-rIS/user/discovery.md new file mode 100644 index 000000000..354687f69 --- /dev/null +++ b/docs/is-rIS/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Ferilkönnun + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/is-rIS/user/firmware.md b/docs/is-rIS/user/firmware.md new file mode 100644 index 000000000..cb5973377 --- /dev/null +++ b/docs/is-rIS/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Channel | Lýsing | +| ------- | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/is-rIS/user/map-and-waypoints.md b/docs/is-rIS/user/map-and-waypoints.md new file mode 100644 index 000000000..0f1553fc7 --- /dev/null +++ b/docs/is-rIS/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Lýsing | +| ---------- | ------------------------------------------------------- | +| Heiti | Short identifier (max 30 characters) | +| Lýsing | Optional longer description | +| Icon | Visual marker emoji on the map | +| Læst | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/is-rIS/user/messages-and-channels.md b/docs/is-rIS/user/messages-and-channels.md new file mode 100644 index 000000000..d5ee7d8f1 --- /dev/null +++ b/docs/is-rIS/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Lýsing | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Error | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Error | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| No Interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| No Channel | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Bad Request | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/is-rIS/user/mqtt.md b/docs/is-rIS/user/mqtt.md new file mode 100644 index 000000000..bbdf5507f --- /dev/null +++ b/docs/is-rIS/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Lýsing | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Lýsing | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Lýsing | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/is-rIS/user/node-metrics.md b/docs/is-rIS/user/node-metrics.md new file mode 100644 index 000000000..495fa447a --- /dev/null +++ b/docs/is-rIS/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Lýsing | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperature | BME280, BME680, SHT31 | +| Humidity | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Lýsing | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Good | +| -10 to 0 dB | Fair | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Lýsing | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Ferilkönnun + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Log + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/is-rIS/user/nodes.md b/docs/is-rIS/user/nodes.md new file mode 100644 index 000000000..4d5214729 --- /dev/null +++ b/docs/is-rIS/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Lýsing | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Óska eftir staðsetningu + - Mark as favorite + - Ferilkönnun + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Lýsing | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Lýsing | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Last heard | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distance | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/is-rIS/user/onboarding.md b/docs/is-rIS/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/is-rIS/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/is-rIS/user/settings-module-admin.md b/docs/is-rIS/user/settings-module-admin.md new file mode 100644 index 000000000..bdbd58a69 --- /dev/null +++ b/docs/is-rIS/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Lýsing | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Lýsing | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Lýsing | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Lýsing | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Lýsing | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Lýsing | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Lýsing | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Lýsing | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Lýsing | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Lýsing | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Lýsing | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Lýsing | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Lýsing | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Remote Administration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Endurræsa + +Remotely reboot a connected or administered node. + +### Villuleitarborð + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/is-rIS/user/settings-radio-user.md b/docs/is-rIS/user/settings-radio-user.md new file mode 100644 index 000000000..6973bc91e --- /dev/null +++ b/docs/is-rIS/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Lýsing | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Lýsing | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Lýsing | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Svæði | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Lýsing | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Lýsing | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Lýsing | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Lýsing | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Lýsing | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Lýsing | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/is-rIS/user/signal-meter.md b/docs/is-rIS/user/signal-meter.md new file mode 100644 index 000000000..d34246d0e --- /dev/null +++ b/docs/is-rIS/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Good | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Fair | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Bad | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| None | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/is-rIS/user/tak.md b/docs/is-rIS/user/tak.md new file mode 100644 index 000000000..d8ab610e7 --- /dev/null +++ b/docs/is-rIS/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Lýsing | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Lýsing | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Lýsing | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/is-rIS/user/telemetry-and-sensors.md b/docs/is-rIS/user/telemetry-and-sensors.md new file mode 100644 index 000000000..aa282a0b2 --- /dev/null +++ b/docs/is-rIS/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Lýsing | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperature | Humidity | Pressure | Notes | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Lýsing | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/is-rIS/user/translate.md b/docs/is-rIS/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/is-rIS/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/is-rIS/user/units-and-locale.md b/docs/is-rIS/user/units-and-locale.md new file mode 100644 index 000000000..5f391111d --- /dev/null +++ b/docs/is-rIS/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperature + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/it-rIT/index.md b/docs/it-rIT/index.md new file mode 100644 index 000000000..115b4df73 --- /dev/null +++ b/docs/it-rIT/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Descrizione | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/it-rIT/user/connections.md b/docs/it-rIT/user/connections.md new file mode 100644 index 000000000..e878e2f53 --- /dev/null +++ b/docs/it-rIT/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connessioni +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connessioni + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Descrizione | +| ---- | -------------------- | ------------------------------ | +| 🟢 | Connesso | Active radio link established | +| 🟡 | Connessione in corso | Handshake in progress | +| 🔴 | Disconnesso | No active connection | +| ⚪ | Not configured | Nessun dispositivo selezionato | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Configurazione + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configurazione + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/it-rIT/user/desktop.md b/docs/it-rIT/user/desktop.md new file mode 100644 index 000000000..f7acbd500 --- /dev/null +++ b/docs/it-rIT/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Panoramica + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installazione + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Note | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Mappa | ✓ | ✓ | Full parity | +| Impostazioni | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requisiti: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Limitazioni conosciute + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/it-rIT/user/discovery.md b/docs/it-rIT/user/discovery.md new file mode 100644 index 000000000..a143d0240 --- /dev/null +++ b/docs/it-rIT/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informazioni Vicinato + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/it-rIT/user/firmware.md b/docs/it-rIT/user/firmware.md new file mode 100644 index 000000000..63397bd21 --- /dev/null +++ b/docs/it-rIT/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canale | Descrizione | +| ------- | ------------------------------------------- | +| Stabile | Recommended for most users; tested releases | +| Alfa | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Risoluzione problemi + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/it-rIT/user/map-and-waypoints.md b/docs/it-rIT/user/map-and-waypoints.md new file mode 100644 index 000000000..67a62d73d --- /dev/null +++ b/docs/it-rIT/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Verde | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blu | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Descrizione | +| ----------- | ------------------------------------------------------- | +| Nome | Short identifier (max 30 characters) | +| Descrizione | Optional longer description | +| Icon | Visual marker emoji on the map | +| Bloccato | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/it-rIT/user/messages-and-channels.md b/docs/it-rIT/user/messages-and-channels.md new file mode 100644 index 000000000..843dff083 --- /dev/null +++ b/docs/it-rIT/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Canali + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Sicurezza del canale + +Channels support multiple encryption levels: + +| Icon | Security Level | Descrizione | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Messaggi Diretti + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Consegnato | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Errori | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Errori | Meaning | What to Do | +| -------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Nessuna Interfaccia | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Nessun Canale | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Richiesta Non Valida | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Buone pratiche + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/it-rIT/user/mqtt.md b/docs/it-rIT/user/mqtt.md new file mode 100644 index 000000000..cd3dfa599 --- /dev/null +++ b/docs/it-rIT/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Panoramica + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## Come funziona + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configurazione + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Impostazione | Descrizione | Predefinito | +| ---------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Indirizzo Server | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root topic | Base topic for messages | msh | +| Cifratura | Encrypt MQTT payload | Abilitato | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Descrizione | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Descrizione | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Buone pratiche + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Risoluzione problemi + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/it-rIT/user/node-metrics.md b/docs/it-rIT/user/node-metrics.md new file mode 100644 index 000000000..4c5f9a5e0 --- /dev/null +++ b/docs/it-rIT/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Metriche Dispositivo + +Basic operating information reported by each node: + +| Metrico | Descrizione | +| ----------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Tensione | Battery voltage reading | +| Utilizzo Canale | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Tempo di attività | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Metriche Ambientali + +Environmental sensor data (requires compatible hardware): + +| Metrico | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatura | BME280, BME680, SHT31 | +| Umidità | BME280, BME680, SHT31 | +| Pressione barometrica | BME280, BMP280 | +| Resistenza Ai Gas | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metrico | Descrizione | +| ------------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Conteggio Hop | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Buono | +| -10 to 0 dB | Discreto | +| < -10 dB | Poor | + +## Metriche Alimentazione + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metrico | Descrizione | +| ------------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Attuale | Power draw in milliamps | +| Alimentazione | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Registro Posizione + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitudine +- Speed (if moving) +- Timestamp for each position report + +## Informazioni Vicinato + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/it-rIT/user/nodes.md b/docs/it-rIT/user/nodes.md new file mode 100644 index 000000000..3ba02ce9c --- /dev/null +++ b/docs/it-rIT/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodi +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodi + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Ruolo | Descrizione | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Base Client | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Nascosto | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensore | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Visualizza sulla mappa + - Richiedi posizione + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtro | Descrizione | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Descrizione | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ----------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Livello batteria | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Ricevuto più di recente | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distanza | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/it-rIT/user/onboarding.md b/docs/it-rIT/user/onboarding.md new file mode 100644 index 000000000..6765ab198 --- /dev/null +++ b/docs/it-rIT/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Come iniziare +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Come iniziare + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/it-rIT/user/settings-module-admin.md b/docs/it-rIT/user/settings-module-admin.md new file mode 100644 index 000000000..f943a082d --- /dev/null +++ b/docs/it-rIT/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Configurazione modulo + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Impostazione | Descrizione | +| --------------- | ------------------------------------------------------------------------ | +| Abilitato | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Cifratura | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Impostazione | Descrizione | +| ------------ | ------------------------------- | +| Abilitato | Activate serial communication | +| Echo | Echo received serial data back | +| Modalità | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Impostazione | Descrizione | +| -------------------------------- | --------------------------- | +| Abilitato | Activate notifications | +| Messaggio di allerta | Notify on incoming messages | +| Buzzer Messaggio Di Allerta | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Campanella Di Allarme | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Attivo | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Impostazione | Descrizione | +| ------------------------------------------ | -------------------------- | +| Abilitato | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Record | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Impostazione | Descrizione | +| -------------------------------------- | --------------------------------- | +| Abilitato | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Impostazione | Descrizione | +| ----------------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Qualità Dell'Aria Abilitata | Report particulate sensor data | +| Metriche Di Alimentazione Abilitate | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Impostazione | Descrizione | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messaggi | Newline-separated list of messages | +| Invia Campanella | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Impostazione | Descrizione | +| -------------------- | -------------------------------- | +| Abilitato | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| Selezione Parola I2S | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Impostazione | Descrizione | +| -------------------- | --------------------------------------------------------------- | +| Abilitato | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Impostazione | Descrizione | +| -------------------------------------- | ------------------------------------ | +| Abilitato | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Impostazione | Descrizione | +| ------------------ | ---------------------------------------------------------- | +| Abilitato | Activate LED control | +| Stato LED | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Impostazione | Descrizione | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Abilitato | Activate detection sensor | +| Pin Monitor | GPIO pin connected to sensor | +| Rilevamento Trigger su HIGH | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Invia Campanella | Include bell character in alerts | +| Nome Descrittivo | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Impostazione | Descrizione | +| -------------------------------------- | -------------------------- | +| Abilitato | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Amministrazione + +### Amministrazione Remota + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Azzera il database dei nodi + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Riavvia + +Remotely reboot a connected or administered node. + +### Pannello Di Debug + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/it-rIT/user/settings-radio-user.md b/docs/it-rIT/user/settings-radio-user.md new file mode 100644 index 000000000..caad4da73 --- /dev/null +++ b/docs/it-rIT/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - impostazioni + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## Impostazioni Utente + +### User Profile + +| Impostazione | Descrizione | +| ----------------- | ------------------------------------------------------------------------------------- | +| Nome Lungo | Your display name (up to 39 characters) | +| Nome Breve | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Configurazione Radio + +### Configurazione Dispositivo + +| Impostazione | Descrizione | Predefinito | +| ------------------------------------------ | ----------------------------------------------------------------------- | ----------- | +| Ruolo | Node behavior (Client, Router, etc.) | Client | +| Modalità Ritrasmissione | How the node retransmits messages | Tutti | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### Configurazione LoRa + +| Impostazione | Descrizione | Predefinito | +| -------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regione | Regulatory region for frequency bands | Unset (must configure) | +| Configurazione Modem | Speed/range tradeoff | LongFast | +| Limite di hop | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Offset Di Frequenza | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Velocità | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0,34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0,18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Configurazione Schermo + +| Impostazione | Descrizione | +| -------------------- | ------------------------------------------------------------------------------------ | +| Timeout Schermo | Time before display sleeps | +| Mostra Unità | Metric or Imperial | +| Tipo OLED | Auto, SSD1306, SH1106, SH1107 | +| Orientamento bussola | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Configurazione Posizione + +| Impostazione | Descrizione | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| Intervallo di aggiornamento GPS | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Posizione Smart | Enable movement-based broadcasting | +| Posizione Fissa | Use a manually set position | + +### Configurazione Alimentazione + +| Impostazione | Descrizione | +| --------------------------------------- | --------------------------------------- | +| Risparmio energetico | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Configurazione Della Rete + +| Impostazione | Descrizione | +| -------------- | ---------------------------------------------------- | +| WiFi abilitato | Enable WiFi radio (ESP32 devices) | +| SSID WiFi | Network name to connect to | +| WiFi PSK | Password di rete | +| Server NTP | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Configurazione Bluetooth + +| Impostazione | Descrizione | +| ----------------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Modalità di abbinamento | Fixed PIN, Random PIN, or No PIN | +| PIN Fisso | PIN code for pairing (default: 123456) | + +### Configurazione Sicurezza + +| Impostazione | Descrizione | +| ------------------------------- | -------------------------------------------------------------------------- | +| Chiave Pubblica | Your node's public key (read-only) | +| Chiave Amministratore | Key for remote administration | +| Chiave Privata | Your node's private key (handle securely) | +| Canale Amministratore Abilitato | Allow admin commands via channel | +| Log di debug | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Modalità Gestita | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/it-rIT/user/signal-meter.md b/docs/it-rIT/user/signal-meter.md new file mode 100644 index 000000000..d5c409beb --- /dev/null +++ b/docs/it-rIT/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| -------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Buono | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Discreto | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Scarso | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Nessuno | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/it-rIT/user/tak.md b/docs/it-rIT/user/tak.md new file mode 100644 index 000000000..6b6333eeb --- /dev/null +++ b/docs/it-rIT/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Panoramica + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Configurazione + +### Prerequisiti + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configurazione + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Impostazione | Descrizione | +| ------------ | -------------------------- | +| Abilitato | Activate TAK interop | +| Modalità | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Ruolo | Descrizione | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Impostazione | Descrizione | +| ------------ | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Ruolo | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Caratteristiche | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Risoluzione problemi + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/it-rIT/user/telemetry-and-sensors.md b/docs/it-rIT/user/telemetry-and-sensors.md new file mode 100644 index 000000000..2dd6dcd49 --- /dev/null +++ b/docs/it-rIT/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Panoramica + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Telemetria dispositivo + +All Meshtastic nodes report basic device telemetry: + +| Metrico | Descrizione | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Tensione | Battery voltage | 3.0–4.2V (LiPo) | +| Utilizzo Canale | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Tempo di attività | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensore | Temperatura | Umidità | Pressione | Note | +| ------- | ----------- | ------- | --------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensore | Metrico | Note | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensore | Metrico | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Metriche Alimentazione + +Nodes with INA-series power sensors can report: + +| Metrico | Descrizione | +| ------------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Attuale | Power consumption (mA) | +| Alimentazione | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Risoluzione problemi + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/it-rIT/user/translate.md b/docs/it-rIT/user/translate.md new file mode 100644 index 000000000..7ce5188ab --- /dev/null +++ b/docs/it-rIT/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Note | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/it-rIT/user/units-and-locale.md b/docs/it-rIT/user/units-and-locale.md new file mode 100644 index 000000000..5c954f9aa --- /dev/null +++ b/docs/it-rIT/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## Come funziona + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatura + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitudine | +| -------------------------------- | -------------- | ---------------------- | ---------- | +| Metrico | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Velocità + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrico | 12 km/h | +| Imperial (US) | 7 mph | + +## Vento + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metrico | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metrico | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Pressione barometrica | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiazione | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Impostazione | What It Controls | Esempio | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/iw-rIL/index.md b/docs/iw-rIL/index.md new file mode 100644 index 000000000..56a75c822 --- /dev/null +++ b/docs/iw-rIL/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | תיאור | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/iw-rIL/user/connections.md b/docs/iw-rIL/user/connections.md new file mode 100644 index 000000000..5df8d1956 --- /dev/null +++ b/docs/iw-rIL/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | תיאור | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | מנותק | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/iw-rIL/user/desktop.md b/docs/iw-rIL/user/desktop.md new file mode 100644 index 000000000..b38371a62 --- /dev/null +++ b/docs/iw-rIL/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| מפה | ✓ | ✓ | Full parity | +| הגדרות | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/iw-rIL/user/discovery.md b/docs/iw-rIL/user/discovery.md new file mode 100644 index 000000000..e56066d7a --- /dev/null +++ b/docs/iw-rIL/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## בדיקת מסלול + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/iw-rIL/user/firmware.md b/docs/iw-rIL/user/firmware.md new file mode 100644 index 000000000..de781e08a --- /dev/null +++ b/docs/iw-rIL/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| ערוץ | תיאור | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/iw-rIL/user/map-and-waypoints.md b/docs/iw-rIL/user/map-and-waypoints.md new file mode 100644 index 000000000..755da6636 --- /dev/null +++ b/docs/iw-rIL/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | תיאור | +| ---------- | ------------------------------------------------------- | +| שם | Short identifier (max 30 characters) | +| תיאור | Optional longer description | +| Icon | Visual marker emoji on the map | +| נעול | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/iw-rIL/user/messages-and-channels.md b/docs/iw-rIL/user/messages-and-channels.md new file mode 100644 index 000000000..241b1625c --- /dev/null +++ b/docs/iw-rIL/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | תיאור | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| שגיאה | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| שגיאה | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| No Interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| No Channel | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Bad Request | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/iw-rIL/user/mqtt.md b/docs/iw-rIL/user/mqtt.md new file mode 100644 index 000000000..ced03953c --- /dev/null +++ b/docs/iw-rIL/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | תיאור | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | תיאור | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | תיאור | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/iw-rIL/user/node-metrics.md b/docs/iw-rIL/user/node-metrics.md new file mode 100644 index 000000000..44d643dd9 --- /dev/null +++ b/docs/iw-rIL/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | תיאור | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperature | BME280, BME680, SHT31 | +| Humidity | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | תיאור | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Good | +| -10 to 0 dB | Fair | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | תיאור | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## בדיקת מסלול + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Log + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/iw-rIL/user/nodes.md b/docs/iw-rIL/user/nodes.md new file mode 100644 index 000000000..034c982a7 --- /dev/null +++ b/docs/iw-rIL/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | תיאור | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - בקש מיקום + - Mark as favorite + - בדיקת מסלול + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| פילטר | תיאור | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | תיאור | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Last heard | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| מרחק | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/iw-rIL/user/onboarding.md b/docs/iw-rIL/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/iw-rIL/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/iw-rIL/user/settings-module-admin.md b/docs/iw-rIL/user/settings-module-admin.md new file mode 100644 index 000000000..5d8c599cd --- /dev/null +++ b/docs/iw-rIL/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | תיאור | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | תיאור | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | תיאור | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | תיאור | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | תיאור | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | תיאור | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | תיאור | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| הודעות | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | תיאור | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | תיאור | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | תיאור | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | תיאור | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | תיאור | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | תיאור | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Remote Administration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### אתחול מחדש + +Remotely reboot a connected or administered node. + +### פאנל דיבאג + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/iw-rIL/user/settings-radio-user.md b/docs/iw-rIL/user/settings-radio-user.md new file mode 100644 index 000000000..1fb7349b8 --- /dev/null +++ b/docs/iw-rIL/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - הגדרות + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | תיאור | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | תיאור | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | תיאור | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| אזור | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | תיאור | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | תיאור | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | תיאור | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | תיאור | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | תיאור | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | תיאור | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/iw-rIL/user/signal-meter.md b/docs/iw-rIL/user/signal-meter.md new file mode 100644 index 000000000..d34246d0e --- /dev/null +++ b/docs/iw-rIL/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Good | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Fair | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Bad | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| None | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/iw-rIL/user/tak.md b/docs/iw-rIL/user/tak.md new file mode 100644 index 000000000..8bc2bb38f --- /dev/null +++ b/docs/iw-rIL/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | תיאור | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | תיאור | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | תיאור | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/iw-rIL/user/telemetry-and-sensors.md b/docs/iw-rIL/user/telemetry-and-sensors.md new file mode 100644 index 000000000..b6b3a5e2d --- /dev/null +++ b/docs/iw-rIL/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | תיאור | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperature | Humidity | Pressure | Notes | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | תיאור | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/iw-rIL/user/translate.md b/docs/iw-rIL/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/iw-rIL/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/iw-rIL/user/units-and-locale.md b/docs/iw-rIL/user/units-and-locale.md new file mode 100644 index 000000000..5f391111d --- /dev/null +++ b/docs/iw-rIL/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperature + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/ja-rJP/index.md b/docs/ja-rJP/index.md new file mode 100644 index 000000000..761468611 --- /dev/null +++ b/docs/ja-rJP/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | 説明 | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/ja-rJP/user/connections.md b/docs/ja-rJP/user/connections.md new file mode 100644 index 000000000..783641ba5 --- /dev/null +++ b/docs/ja-rJP/user/connections.md @@ -0,0 +1,125 @@ +--- +title: コネクション +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# コネクション + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | 説明 | +| ---- | -------------- | ----------------------------- | +| 🟢 | 接続済 | Active radio link established | +| 🟡 | 接続中 | Handshake in progress | +| 🔴 | 切断 | No active connection | +| ⚪ | Not configured | デバイスが選択されていません | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### 設定 + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ja-rJP/user/desktop.md b/docs/ja-rJP/user/desktop.md new file mode 100644 index 000000000..73beb6ab1 --- /dev/null +++ b/docs/ja-rJP/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| 地図 | ✓ | ✓ | Full parity | +| 設定 | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ja-rJP/user/discovery.md b/docs/ja-rJP/user/discovery.md new file mode 100644 index 000000000..632238dae --- /dev/null +++ b/docs/ja-rJP/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: ディスカバリー +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# ディスカバリー + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## ルート追跡 + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## 隣接ノード情報 + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ja-rJP/user/firmware.md b/docs/ja-rJP/user/firmware.md new file mode 100644 index 000000000..84d33d5c2 --- /dev/null +++ b/docs/ja-rJP/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| チャンネル | 説明 | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ja-rJP/user/map-and-waypoints.md b/docs/ja-rJP/user/map-and-waypoints.md new file mode 100644 index 000000000..299e8bf8d --- /dev/null +++ b/docs/ja-rJP/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ----- | ---------------------------------------------- | +| 緑 | Online (heard recently) | +| 黄色 | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| 青 | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | 説明 | +| ---------- | ------------------------------------------------------- | +| 名前 | Short identifier (max 30 characters) | +| 説明 | Optional longer description | +| Icon | Visual marker emoji on the map | +| ロック済み | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ja-rJP/user/messages-and-channels.md b/docs/ja-rJP/user/messages-and-channels.md new file mode 100644 index 000000000..f97ead3c9 --- /dev/null +++ b/docs/ja-rJP/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## チャンネル + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | 説明 | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| エラー | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| エラー | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| タイムアウト | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| インターフェースがありません | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| チャンネルがありません | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| 不正な要求 | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ja-rJP/user/mqtt.md b/docs/ja-rJP/user/mqtt.md new file mode 100644 index 000000000..7f01dcb24 --- /dev/null +++ b/docs/ja-rJP/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## 設定 + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | 説明 | デフォルト | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| ユーザー名 | Broker authentication | meshdev | +| パスワード | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | 説明 | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | 説明 | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ja-rJP/user/node-metrics.md b/docs/ja-rJP/user/node-metrics.md new file mode 100644 index 000000000..64dd80b19 --- /dev/null +++ b/docs/ja-rJP/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | 説明 | +| ------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| 電圧 | Battery voltage reading | +| チャンネル全体の利用率 | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| 連続稼働時間 | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| 温度 | BME280, BME680, SHT31 | +| 湿度 | BME280, BME680, SHT31 | +| 大気圧 | BME280, BMP280 | +| ガス圧 | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | 説明 | +| --------- | ----------------------------------------------------------------------------- | +| SN比 | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | 良 | +| -10 to 0 dB | 普通 | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | 説明 | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| 電流 | Power draw in milliamps | +| 電源 | Calculated wattage | + +## ルート追跡 + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## 位置ログ + +Historical position data for nodes that share their location: + +- GPS coordinates +- 標高 +- Speed (if moving) +- Timestamp for each position report + +## 隣接ノード情報 + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ja-rJP/user/nodes.md b/docs/ja-rJP/user/nodes.md new file mode 100644 index 000000000..1db320d49 --- /dev/null +++ b/docs/ja-rJP/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: ノード +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# ノード + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| 役割 | 説明 | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| クライアント | Standard end-user device | +| クライアント・ベース | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| クライアント・ミュート | Receives but doesn't retransmit | +| クライアント・非表示 | Like Client Mute, plus hides from node list | +| ルーター | Prioritizes message forwarding; stays awake to relay | +| ルーター・レイト | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| トラッカー | Optimized for position reporting at regular intervals | +| センサー | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - 位置を求める + - Mark as favorite + - ルート追跡 + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| 絞り込み | 説明 | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | 説明 | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| 最後の通信 | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| 距離 | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ja-rJP/user/onboarding.md b/docs/ja-rJP/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ja-rJP/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ja-rJP/user/settings-module-admin.md b/docs/ja-rJP/user/settings-module-admin.md new file mode 100644 index 000000000..e55c720d6 --- /dev/null +++ b/docs/ja-rJP/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | 説明 | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| サーバー | MQTT broker address | +| ユーザー名 | Authentication username | +| パスワード | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | 説明 | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | 説明 | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | 説明 | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | 説明 | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | 説明 | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | 説明 | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| メッセージ | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | 説明 | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | 説明 | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | 説明 | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | 説明 | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | 説明 | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | 説明 | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## 管理 + +### リモート管理 + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### 再起動 + +Remotely reboot a connected or administered node. + +### デバッグ + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ja-rJP/user/settings-radio-user.md b/docs/ja-rJP/user/settings-radio-user.md new file mode 100644 index 000000000..eb5d6bb9b --- /dev/null +++ b/docs/ja-rJP/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - 設定 + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | 説明 | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### デバイスの設定 + +| Setting | 説明 | デフォルト | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| 役割 | Node behavior (Client, Router, etc.) | クライアント | +| Rebroadcast Mode | How the node retransmits messages | すべて | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa設定 + +| Setting | 説明 | デフォルト | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| リージョン | Regulatory region for frequency bands | Unset (must configure) | +| モデムプリセット | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### 表示設定 + +| Setting | 説明 | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### 位置情報設定 + +| Setting | 説明 | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| 固定位置 | Use a manually set position | + +### 電源設定 + +| Setting | 説明 | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### ネットワーク設定 + +| Setting | 説明 | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth 設定 + +| Setting | 説明 | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| PINコード | PIN code for pairing (default: 123456) | + +### セキュリティ設定 + +| Setting | 説明 | +| --------------------- | -------------------------------------------------------------------------- | +| 公開鍵 | Your node's public key (read-only) | +| 管理者キー | Key for remote administration | +| 秘密鍵 | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| 管理モード | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ja-rJP/user/signal-meter.md b/docs/ja-rJP/user/signal-meter.md new file mode 100644 index 000000000..2482815ff --- /dev/null +++ b/docs/ja-rJP/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| 良 | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| 普通 | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| 不良 | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| なし | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ja-rJP/user/tak.md b/docs/ja-rJP/user/tak.md new file mode 100644 index 000000000..95966913a --- /dev/null +++ b/docs/ja-rJP/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### 設定 + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | 説明 | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| 役割 | 説明 | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | 説明 | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| 役割 | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ja-rJP/user/telemetry-and-sensors.md b/docs/ja-rJP/user/telemetry-and-sensors.md new file mode 100644 index 000000000..5abe5e378 --- /dev/null +++ b/docs/ja-rJP/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | 説明 | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| 電圧 | Battery voltage | 3.0–4.2V (LiPo) | +| チャンネル全体の利用率 | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| 連続稼働時間 | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| センサー | 温度 | 湿度 | 気圧 | Notes | +| ------- | -- | -- | -- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| センサー | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| センサー | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | 説明 | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| 電流 | Power consumption (mA) | +| 電源 | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ja-rJP/user/translate.md b/docs/ja-rJP/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/ja-rJP/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/ja-rJP/user/units-and-locale.md b/docs/ja-rJP/user/units-and-locale.md new file mode 100644 index 000000000..9a2fe61c6 --- /dev/null +++ b/docs/ja-rJP/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## 温度 + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | 標高 | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## 風力 + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| 放射線 | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/ko-rKR/index.md b/docs/ko-rKR/index.md new file mode 100644 index 000000000..9b15258d6 --- /dev/null +++ b/docs/ko-rKR/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | 설명 | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/ko-rKR/user/connections.md b/docs/ko-rKR/user/connections.md new file mode 100644 index 000000000..f3e3f456f --- /dev/null +++ b/docs/ko-rKR/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | 설명 | +| ---- | -------------- | ----------------------------- | +| 🟢 | 연결됨 | Active radio link established | +| 🟡 | 연결 중 | Handshake in progress | +| 🔴 | 연결 끊김 | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### 설정 + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ko-rKR/user/desktop.md b/docs/ko-rKR/user/desktop.md new file mode 100644 index 000000000..575b57945 --- /dev/null +++ b/docs/ko-rKR/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| 지도 | ✓ | ✓ | Full parity | +| 설정 | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ko-rKR/user/discovery.md b/docs/ko-rKR/user/discovery.md new file mode 100644 index 000000000..9f8a76924 --- /dev/null +++ b/docs/ko-rKR/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## 추적 루트 + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## 이웃 정보 + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ko-rKR/user/firmware.md b/docs/ko-rKR/user/firmware.md new file mode 100644 index 000000000..8c7f03bca --- /dev/null +++ b/docs/ko-rKR/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| 채널 | 설명 | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ko-rKR/user/map-and-waypoints.md b/docs/ko-rKR/user/map-and-waypoints.md new file mode 100644 index 000000000..b0ba11429 --- /dev/null +++ b/docs/ko-rKR/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| 초록 | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| 파랑 | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | 설명 | +| ---------- | ------------------------------------------------------- | +| 이름 | Short identifier (max 30 characters) | +| 설명 | Optional longer description | +| Icon | Visual marker emoji on the map | +| 잠김 | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ko-rKR/user/messages-and-channels.md b/docs/ko-rKR/user/messages-and-channels.md new file mode 100644 index 000000000..015409b38 --- /dev/null +++ b/docs/ko-rKR/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## 채널 + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | 설명 | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| 전송됨 | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Error | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Error | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| 시간 초과 | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| 인터페이스 없음 | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| 채널 없음 | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| 잘못된 요청 | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ko-rKR/user/mqtt.md b/docs/ko-rKR/user/mqtt.md new file mode 100644 index 000000000..bd48b97a6 --- /dev/null +++ b/docs/ko-rKR/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## 설정 + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | 설명 | 기본값 | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| 사용자명 | Broker authentication | meshdev | +| 비밀번호 | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| 암호화 | Encrypt MQTT payload | 활성화 | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | 설명 | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | 설명 | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ko-rKR/user/node-metrics.md b/docs/ko-rKR/user/node-metrics.md new file mode 100644 index 000000000..484a633b7 --- /dev/null +++ b/docs/ko-rKR/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | 설명 | +| ------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| 전압 | Battery voltage reading | +| 채널 사용 | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| 업타임 | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| 온도 | BME280, BME680, SHT31 | +| 습도 | BME280, BME680, SHT31 | +| 기압 | BME280, BMP280 | +| 가스 저항 | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | 설명 | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | 좋음 | +| -10 to 0 dB | 보통 | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | 설명 | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| 전류 | Power draw in milliamps | +| 전원 | Calculated wattage | + +## 추적 루트 + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## 위치 로그 + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## 이웃 정보 + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ko-rKR/user/nodes.md b/docs/ko-rKR/user/nodes.md new file mode 100644 index 000000000..ca5fd959d --- /dev/null +++ b/docs/ko-rKR/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: 노드 +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# 노드 + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| 역할 | 설명 | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - 위치 요청 + - Mark as favorite + - 추적 루트 + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| 필터 | 설명 | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | 설명 | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| 최근 수신 | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| 거리 | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ko-rKR/user/onboarding.md b/docs/ko-rKR/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ko-rKR/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ko-rKR/user/settings-module-admin.md b/docs/ko-rKR/user/settings-module-admin.md new file mode 100644 index 000000000..72be29594 --- /dev/null +++ b/docs/ko-rKR/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | 설명 | +| --------------- | ------------------------------------------------------------------------ | +| 활성화 | Toggle MQTT bridge | +| 서버 | MQTT broker address | +| 사용자명 | Authentication username | +| 비밀번호 | Authentication password | +| 암호화 | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | 설명 | +| ---------- | ------------------------------- | +| 활성화 | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | 설명 | +| -------------------------------- | --------------------------- | +| 활성화 | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | 설명 | +| ------------------------------------------ | -------------------------- | +| 활성화 | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| 레코드 | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | 설명 | +| -------------------------------------- | --------------------------------- | +| 활성화 | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | 설명 | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | 설명 | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| 메시지기기 | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | 설명 | +| --------------- | -------------------------------- | +| 활성화 | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | 설명 | +| -------------------- | --------------------------------------------------------------- | +| 활성화 | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | 설명 | +| -------------------------------------- | ------------------------------------ | +| 활성화 | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | 설명 | +| ------------------ | ---------------------------------------------------------- | +| 활성화 | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | 설명 | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| 활성화 | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | 설명 | +| -------------------------------------- | -------------------------- | +| 활성화 | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## 관리 + +### 원격 설정 + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### 재부팅 + +Remotely reboot a connected or administered node. + +### 디버그 패널 + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ko-rKR/user/settings-radio-user.md b/docs/ko-rKR/user/settings-radio-user.md new file mode 100644 index 000000000..90970f11e --- /dev/null +++ b/docs/ko-rKR/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - 설정 + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | 설명 | +| ----------------- | ------------------------------------------------------------------------------------- | +| 긴 이름 | Your display name (up to 39 characters) | +| 짧은 이름 | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### 장치 설정 + +| Setting | 설명 | 기본값 | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| 역할 | Node behavior (Client, Router, etc.) | Client | +| 중계 모드 | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa 설정 + +| Setting | 설명 | 기본값 | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| 지역 | Regulatory region for frequency bands | Unset (must configure) | +| 모뎀 프리셋 | Speed/range tradeoff | LongFast | +| Hop 제한 | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| 주파수 오프셋 | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### 화면 설정 + +| Setting | 설명 | +| ------------------- | ------------------------------------------------------------------------------------ | +| 화면 끄기 시간 | Time before display sleeps | +| 단위 표시 | Metric or Imperial | +| OLED 타입 | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### 위치 설정 + +| Setting | 설명 | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### 전원 설정 + +| Setting | 설명 | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### 네트워크 설정 + +| Setting | 설명 | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | 네트워크 암호 | +| NTP 서버 | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### 블루투스 설정 + +| Setting | 설명 | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| 고정 PIN | PIN code for pairing (default: 123456) | + +### 보안 설정 + +| Setting | 설명 | +| --------------------- | -------------------------------------------------------------------------- | +| 공개 키 | Your node's public key (read-only) | +| Admin 키 | Key for remote administration | +| 개인 키 | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| 관리 모드 | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ko-rKR/user/signal-meter.md b/docs/ko-rKR/user/signal-meter.md new file mode 100644 index 000000000..d6a5ab87e --- /dev/null +++ b/docs/ko-rKR/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| 좋음 | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| 보통 | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| 나쁨 | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| 없음 | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ko-rKR/user/tak.md b/docs/ko-rKR/user/tak.md new file mode 100644 index 000000000..81de164fd --- /dev/null +++ b/docs/ko-rKR/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### 설정 + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | 설명 | +| ------- | -------------------------- | +| 활성화 | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| 역할 | 설명 | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | 설명 | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| 역할 | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ko-rKR/user/telemetry-and-sensors.md b/docs/ko-rKR/user/telemetry-and-sensors.md new file mode 100644 index 000000000..e92eb8c8b --- /dev/null +++ b/docs/ko-rKR/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | 설명 | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| 전압 | Battery voltage | 3.0–4.2V (LiPo) | +| 채널 사용 | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| 업타임 | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | 온도 | 습도 | 기압 | Notes | +| ------- | -- | -- | -- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | 설명 | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| 전류 | Power consumption (mA) | +| 전원 | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ko-rKR/user/translate.md b/docs/ko-rKR/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/ko-rKR/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/ko-rKR/user/units-and-locale.md b/docs/ko-rKR/user/units-and-locale.md new file mode 100644 index 000000000..0720f7226 --- /dev/null +++ b/docs/ko-rKR/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## 온도 + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## 바람 + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| 복사 | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/lt-rLT/index.md b/docs/lt-rLT/index.md new file mode 100644 index 000000000..6126919ea --- /dev/null +++ b/docs/lt-rLT/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Aprašymas | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/lt-rLT/user/connections.md b/docs/lt-rLT/user/connections.md new file mode 100644 index 000000000..1c1d8c8d7 --- /dev/null +++ b/docs/lt-rLT/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Aprašymas | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Atsijungta | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/lt-rLT/user/desktop.md b/docs/lt-rLT/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/lt-rLT/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/lt-rLT/user/discovery.md b/docs/lt-rLT/user/discovery.md new file mode 100644 index 000000000..87ed93fa3 --- /dev/null +++ b/docs/lt-rLT/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Žinutės kelias + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/lt-rLT/user/firmware.md b/docs/lt-rLT/user/firmware.md new file mode 100644 index 000000000..e6b69bf01 --- /dev/null +++ b/docs/lt-rLT/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanalas | Aprašymas | +| ------- | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/lt-rLT/user/map-and-waypoints.md b/docs/lt-rLT/user/map-and-waypoints.md new file mode 100644 index 000000000..450d5f918 --- /dev/null +++ b/docs/lt-rLT/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Aprašymas | +| ----------- | ------------------------------------------------------- | +| Pavadinimas | Short identifier (max 30 characters) | +| Aprašymas | Optional longer description | +| Icon | Visual marker emoji on the map | +| Užrakintas | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/lt-rLT/user/messages-and-channels.md b/docs/lt-rLT/user/messages-and-channels.md new file mode 100644 index 000000000..9a09b5796 --- /dev/null +++ b/docs/lt-rLT/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Aprašymas | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Klaida | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Klaida | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Baigėsi laikas | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Nėra sąsajos | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Nėra kanalo | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Bloga užklausa | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/lt-rLT/user/mqtt.md b/docs/lt-rLT/user/mqtt.md new file mode 100644 index 000000000..6ecbde368 --- /dev/null +++ b/docs/lt-rLT/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Aprašymas | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Aprašymas | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Aprašymas | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/lt-rLT/user/node-metrics.md b/docs/lt-rLT/user/node-metrics.md new file mode 100644 index 000000000..a9d8d3b1e --- /dev/null +++ b/docs/lt-rLT/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Aprašymas | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Kanalo panaudojimas | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatūra | BME280, BME680, SHT31 | +| Drėgmė | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Aprašymas | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ---------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Geras | +| -10 to 0 dB | Pakankamas | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Aprašymas | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Žinutės kelias + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Pozicijos duomenų žurnalas + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/lt-rLT/user/nodes.md b/docs/lt-rLT/user/nodes.md new file mode 100644 index 000000000..3ee75ecb2 --- /dev/null +++ b/docs/lt-rLT/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Aprašymas | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Prašyti pozicijos + - Mark as favorite + - Žinutės kelias + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtras | Aprašymas | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Aprašymas | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Seniausiai girdėtas | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Atstumas | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/lt-rLT/user/onboarding.md b/docs/lt-rLT/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/lt-rLT/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/lt-rLT/user/settings-module-admin.md b/docs/lt-rLT/user/settings-module-admin.md new file mode 100644 index 000000000..f01695beb --- /dev/null +++ b/docs/lt-rLT/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Aprašymas | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Aprašymas | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Aprašymas | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Aprašymas | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Aprašymas | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Aprašymas | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Aprašymas | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Aprašymas | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Aprašymas | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Aprašymas | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Aprašymas | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Aprašymas | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Aprašymas | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administravimas + +### Nuotolinis administravimas + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Perkrauti + +Remotely reboot a connected or administered node. + +### Derinimo skydelis + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/lt-rLT/user/settings-radio-user.md b/docs/lt-rLT/user/settings-radio-user.md new file mode 100644 index 000000000..c6d2e1225 --- /dev/null +++ b/docs/lt-rLT/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Aprašymas | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Aprašymas | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Aprašymas | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regionas | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Aprašymas | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Aprašymas | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Aprašymas | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Aprašymas | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Aprašymas | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Aprašymas | +| --------------------- | -------------------------------------------------------------------------- | +| Viešasis raktas | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Privatus raktas | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/lt-rLT/user/signal-meter.md b/docs/lt-rLT/user/signal-meter.md new file mode 100644 index 000000000..8628212d1 --- /dev/null +++ b/docs/lt-rLT/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ---------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Geras | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Pakankamas | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Silpnas | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Nėra | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/lt-rLT/user/tak.md b/docs/lt-rLT/user/tak.md new file mode 100644 index 000000000..af64f03eb --- /dev/null +++ b/docs/lt-rLT/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Aprašymas | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Aprašymas | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Aprašymas | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/lt-rLT/user/telemetry-and-sensors.md b/docs/lt-rLT/user/telemetry-and-sensors.md new file mode 100644 index 000000000..f0e75697a --- /dev/null +++ b/docs/lt-rLT/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Aprašymas | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Kanalo panaudojimas | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatūra | Drėgmė | Pressure | Notes | +| ------- | ----------- | ------ | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Aprašymas | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/lt-rLT/user/translate.md b/docs/lt-rLT/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/lt-rLT/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/lt-rLT/user/units-and-locale.md b/docs/lt-rLT/user/units-and-locale.md new file mode 100644 index 000000000..1a7613554 --- /dev/null +++ b/docs/lt-rLT/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatūra + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/nl-rNL/index.md b/docs/nl-rNL/index.md new file mode 100644 index 000000000..33c39771f --- /dev/null +++ b/docs/nl-rNL/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Beschrijving | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/nl-rNL/user/connections.md b/docs/nl-rNL/user/connections.md new file mode 100644 index 000000000..835b8ca92 --- /dev/null +++ b/docs/nl-rNL/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Beschrijving | +| ---- | ------------------- | ----------------------------- | +| 🟢 | Verbonden | Active radio link established | +| 🟡 | Bezig met verbinden | Handshake in progress | +| 🔴 | Niet verbonden | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/nl-rNL/user/desktop.md b/docs/nl-rNL/user/desktop.md new file mode 100644 index 000000000..5b55a4758 --- /dev/null +++ b/docs/nl-rNL/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Kaart | ✓ | ✓ | Full parity | +| Instellingen | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/nl-rNL/user/discovery.md b/docs/nl-rNL/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/nl-rNL/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/nl-rNL/user/firmware.md b/docs/nl-rNL/user/firmware.md new file mode 100644 index 000000000..8dd8b8264 --- /dev/null +++ b/docs/nl-rNL/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanaal | Beschrijving | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/nl-rNL/user/map-and-waypoints.md b/docs/nl-rNL/user/map-and-waypoints.md new file mode 100644 index 000000000..110ce6e80 --- /dev/null +++ b/docs/nl-rNL/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Groen | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blauw | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Beschrijving | +| ------------ | ------------------------------------------------------- | +| Naam | Short identifier (max 30 characters) | +| Beschrijving | Optional longer description | +| Icon | Visual marker emoji on the map | +| Vergrendeld | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/nl-rNL/user/messages-and-channels.md b/docs/nl-rNL/user/messages-and-channels.md new file mode 100644 index 000000000..3a315eb2f --- /dev/null +++ b/docs/nl-rNL/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanalen + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Beschrijving | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Foutmelding | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Foutmelding | Meaning | What to Do | +| ------------------ | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Time-Out | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Geen Interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Geen Kanaal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Ongeldige aanvraag | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/nl-rNL/user/mqtt.md b/docs/nl-rNL/user/mqtt.md new file mode 100644 index 000000000..64be08742 --- /dev/null +++ b/docs/nl-rNL/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Beschrijving | Standaard | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Gebruikersnaam | Broker authentication | meshdev | +| Wachtwoord | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Beschrijving | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Beschrijving | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/nl-rNL/user/node-metrics.md b/docs/nl-rNL/user/node-metrics.md new file mode 100644 index 000000000..5fc3d8ec9 --- /dev/null +++ b/docs/nl-rNL/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Beschrijving | +| ------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Spanning | Battery voltage reading | +| Kanaalgebruik | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Tijd online | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatuur | BME280, BME680, SHT31 | +| Vochtigheid | BME280, BME680, SHT31 | +| Luchtdruk | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Beschrijving | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Goed | +| -10 to 0 dB | Matig | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Beschrijving | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Huidige | Power draw in milliamps | +| Vermogen | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Positie Logboek + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/nl-rNL/user/nodes.md b/docs/nl-rNL/user/nodes.md new file mode 100644 index 000000000..1640e1ea0 --- /dev/null +++ b/docs/nl-rNL/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Functie | Beschrijving | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Positie aanvragen + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Beschrijving | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Beschrijving | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Laatst gehoord | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Afstand | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/nl-rNL/user/onboarding.md b/docs/nl-rNL/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/nl-rNL/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/nl-rNL/user/settings-module-admin.md b/docs/nl-rNL/user/settings-module-admin.md new file mode 100644 index 000000000..1e74edcab --- /dev/null +++ b/docs/nl-rNL/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Beschrijving | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Gebruikersnaam | Authentication username | +| Wachtwoord | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Beschrijving | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Beschrijving | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Beschrijving | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Beschrijving | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Beschrijving | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Beschrijving | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Berichten | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Beschrijving | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Beschrijving | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Beschrijving | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Beschrijving | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Beschrijving | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Beschrijving | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Beheer + +### Extern beheer + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Herstart + +Remotely reboot a connected or administered node. + +### Debug-paneel + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/nl-rNL/user/settings-radio-user.md b/docs/nl-rNL/user/settings-radio-user.md new file mode 100644 index 000000000..9b0d9de35 --- /dev/null +++ b/docs/nl-rNL/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - instellingen + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Beschrijving | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Apparaat Configuratie + +| Setting | Beschrijving | Standaard | +| ------------------------------------------ | ----------------------------------------------------------------------- | --------- | +| Functie | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | Alles | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Configuratie + +| Setting | Beschrijving | Standaard | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regio | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Weergave Configuratie + +| Setting | Beschrijving | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Positie Configuratie + +| Setting | Beschrijving | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Energie configuratie + +| Setting | Beschrijving | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Netwerkconfiguratie + +| Setting | Beschrijving | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Configuratie + +| Setting | Beschrijving | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Vaste PIN | PIN code for pairing (default: 123456) | + +### Beveiligings Configuratie + +| Setting | Beschrijving | +| --------------------- | -------------------------------------------------------------------------- | +| Publieke sleutel | Your node's public key (read-only) | +| Admin Sleutel | Key for remote administration | +| Privésleutel | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Beheerde modus | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/nl-rNL/user/signal-meter.md b/docs/nl-rNL/user/signal-meter.md new file mode 100644 index 000000000..a14435321 --- /dev/null +++ b/docs/nl-rNL/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------ | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Goed | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Matig | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Slecht | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Geen | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/nl-rNL/user/tak.md b/docs/nl-rNL/user/tak.md new file mode 100644 index 000000000..992d4f192 --- /dev/null +++ b/docs/nl-rNL/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Beschrijving | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Functie | Beschrijving | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Beschrijving | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Functie | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/nl-rNL/user/telemetry-and-sensors.md b/docs/nl-rNL/user/telemetry-and-sensors.md new file mode 100644 index 000000000..0fc67157c --- /dev/null +++ b/docs/nl-rNL/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Beschrijving | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Spanning | Battery voltage | 3.0–4.2V (LiPo) | +| Kanaalgebruik | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Tijd online | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatuur | Vochtigheid | Druk | Notes | +| ------- | ----------- | ----------- | ---- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Beschrijving | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Huidige | Power consumption (mA) | +| Vermogen | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/nl-rNL/user/translate.md b/docs/nl-rNL/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/nl-rNL/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/nl-rNL/user/units-and-locale.md b/docs/nl-rNL/user/units-and-locale.md new file mode 100644 index 000000000..a6028461d --- /dev/null +++ b/docs/nl-rNL/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatuur + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Straling | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/no-rNO/index.md b/docs/no-rNO/index.md new file mode 100644 index 000000000..b5dc882bb --- /dev/null +++ b/docs/no-rNO/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Beskrivelse | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/no-rNO/user/connections.md b/docs/no-rNO/user/connections.md new file mode 100644 index 000000000..499280c2c --- /dev/null +++ b/docs/no-rNO/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Beskrivelse | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Frakoblet | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/no-rNO/user/desktop.md b/docs/no-rNO/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/no-rNO/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/no-rNO/user/discovery.md b/docs/no-rNO/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/no-rNO/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/no-rNO/user/firmware.md b/docs/no-rNO/user/firmware.md new file mode 100644 index 000000000..489ce6429 --- /dev/null +++ b/docs/no-rNO/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Beskrivelse | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/no-rNO/user/map-and-waypoints.md b/docs/no-rNO/user/map-and-waypoints.md new file mode 100644 index 000000000..af1f97b19 --- /dev/null +++ b/docs/no-rNO/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Beskrivelse | +| ----------- | ------------------------------------------------------- | +| Navn | Short identifier (max 30 characters) | +| Beskrivelse | Optional longer description | +| Icon | Visual marker emoji on the map | +| Låst | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/no-rNO/user/messages-and-channels.md b/docs/no-rNO/user/messages-and-channels.md new file mode 100644 index 000000000..b772a7751 --- /dev/null +++ b/docs/no-rNO/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Beskrivelse | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Feil | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Feil | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Tidsavbrudd | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Ingen grensesnitt | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Ingen Kanal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Ugyldig Forespørsel | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/no-rNO/user/mqtt.md b/docs/no-rNO/user/mqtt.md new file mode 100644 index 000000000..4209dc753 --- /dev/null +++ b/docs/no-rNO/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Beskrivelse | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Beskrivelse | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Beskrivelse | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/no-rNO/user/node-metrics.md b/docs/no-rNO/user/node-metrics.md new file mode 100644 index 000000000..38eaf7f6c --- /dev/null +++ b/docs/no-rNO/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Beskrivelse | +| --------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Kanalutnyttelse | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatur | BME280, BME680, SHT31 | +| Luftfuktighet | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Beskrivelse | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ----------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Godt | +| -10 to 0 dB | Middelmådig | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Beskrivelse | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Posisjonslogg + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/no-rNO/user/nodes.md b/docs/no-rNO/user/nodes.md new file mode 100644 index 000000000..13cedf8cf --- /dev/null +++ b/docs/no-rNO/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Beskrivelse | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Forespør posisjon + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Beskrivelse | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Beskrivelse | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Sist hørt | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distanse | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/no-rNO/user/onboarding.md b/docs/no-rNO/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/no-rNO/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/no-rNO/user/settings-module-admin.md b/docs/no-rNO/user/settings-module-admin.md new file mode 100644 index 000000000..12d9dd7d1 --- /dev/null +++ b/docs/no-rNO/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Beskrivelse | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Beskrivelse | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Beskrivelse | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Beskrivelse | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Beskrivelse | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Beskrivelse | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Beskrivelse | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Beskrivelse | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Beskrivelse | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Beskrivelse | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Beskrivelse | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Beskrivelse | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Beskrivelse | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administrasjon + +### Fjernadministrasjon + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Omstart + +Remotely reboot a connected or administered node. + +### Feilsøkningspanel + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/no-rNO/user/settings-radio-user.md b/docs/no-rNO/user/settings-radio-user.md new file mode 100644 index 000000000..f27c5eb86 --- /dev/null +++ b/docs/no-rNO/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Beskrivelse | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Beskrivelse | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Beskrivelse | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Region | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Beskrivelse | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Beskrivelse | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Beskrivelse | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Beskrivelse | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Beskrivelse | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Beskrivelse | +| --------------------- | -------------------------------------------------------------------------- | +| Offentlig nøkkel | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Privat nøkkel | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/no-rNO/user/signal-meter.md b/docs/no-rNO/user/signal-meter.md new file mode 100644 index 000000000..674e5318b --- /dev/null +++ b/docs/no-rNO/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Godt | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Middelmådig | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Dårlig | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Ingen | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/no-rNO/user/tak.md b/docs/no-rNO/user/tak.md new file mode 100644 index 000000000..bb860805a --- /dev/null +++ b/docs/no-rNO/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Beskrivelse | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Beskrivelse | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Beskrivelse | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/no-rNO/user/telemetry-and-sensors.md b/docs/no-rNO/user/telemetry-and-sensors.md new file mode 100644 index 000000000..86c2d8ec7 --- /dev/null +++ b/docs/no-rNO/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Beskrivelse | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Kanalutnyttelse | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatur | Luftfuktighet | Pressure | Notes | +| ------- | ---------- | ------------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Beskrivelse | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/no-rNO/user/translate.md b/docs/no-rNO/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/no-rNO/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/no-rNO/user/units-and-locale.md b/docs/no-rNO/user/units-and-locale.md new file mode 100644 index 000000000..386a15ee7 --- /dev/null +++ b/docs/no-rNO/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatur + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/pl-rPL/index.md b/docs/pl-rPL/index.md new file mode 100644 index 000000000..0cb3c90e2 --- /dev/null +++ b/docs/pl-rPL/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Opis | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/pl-rPL/user/connections.md b/docs/pl-rPL/user/connections.md new file mode 100644 index 000000000..a8ddefdde --- /dev/null +++ b/docs/pl-rPL/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Opis | +| ---- | -------------- | ----------------------------- | +| 🟢 | Połączony | Active radio link established | +| 🟡 | Łączenie | Handshake in progress | +| 🔴 | Rozłączono | No active connection | +| ⚪ | Not configured | Nie wybrano urządzenia | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Konfiguracja + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/pl-rPL/user/desktop.md b/docs/pl-rPL/user/desktop.md new file mode 100644 index 000000000..811dce398 --- /dev/null +++ b/docs/pl-rPL/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notatki | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Mapa | ✓ | ✓ | Full parity | +| Ustawienia | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/pl-rPL/user/discovery.md b/docs/pl-rPL/user/discovery.md new file mode 100644 index 000000000..4198aad35 --- /dev/null +++ b/docs/pl-rPL/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Pokaż trasę + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informacje o sąsiadze + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/pl-rPL/user/firmware.md b/docs/pl-rPL/user/firmware.md new file mode 100644 index 000000000..1b4f6e56b --- /dev/null +++ b/docs/pl-rPL/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanał | Opis | +| -------- | ------------------------------------------- | +| Stabilna | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/pl-rPL/user/map-and-waypoints.md b/docs/pl-rPL/user/map-and-waypoints.md new file mode 100644 index 000000000..7972c5e14 --- /dev/null +++ b/docs/pl-rPL/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| --------- | ---------------------------------------------- | +| Zielony | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Niebieski | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Opis | +| ----------- | ------------------------------------------------------- | +| Nazwa | Short identifier (max 30 characters) | +| Opis | Optional longer description | +| Icon | Visual marker emoji on the map | +| Zablokowany | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/pl-rPL/user/messages-and-channels.md b/docs/pl-rPL/user/messages-and-channels.md new file mode 100644 index 000000000..5abd45c33 --- /dev/null +++ b/docs/pl-rPL/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanały + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Bezpieczeństwo kanału + +Channels support multiple encryption levels: + +| Icon | Security Level | Opis | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Bezpośrednie Wiadomości + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Dostarczono | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Błąd | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Błąd | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Brak trasy | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Limit czasu | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Brak interfejsu | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Brak kanału | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Brak odpowiedzi | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Złe żądanie | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/pl-rPL/user/mqtt.md b/docs/pl-rPL/user/mqtt.md new file mode 100644 index 000000000..57858b492 --- /dev/null +++ b/docs/pl-rPL/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Konfiguracja + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Opis | Domyślny | +| ----------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Nazwa użytkownika | Broker authentication | meshdev | +| Hasło | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Szyfrowanie | Encrypt MQTT payload | Włączony | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Wyłączony | +| TLS | Secure connection to broker | Wyłączony | +| Map Reporting | Report position to public map | Wyłączony | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Opis | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Opis | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/pl-rPL/user/node-metrics.md b/docs/pl-rPL/user/node-metrics.md new file mode 100644 index 000000000..5d1a9b008 --- /dev/null +++ b/docs/pl-rPL/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Metryka urządzenia + +Basic operating information reported by each node: + +| Metric | Opis | +| -------------------------- | ----------------------------------- | +| Poziom naładowania baterii | Current battery percentage | +| Napięcie | Battery voltage reading | +| Wykorzystanie kanału | Percentage of airtime consumed | +| Czas nadawania | Transmission time used by this node | +| Czas pracy | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Metryki środowiskowe + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatura | BME280, BME680, SHT31 | +| Wilgotność | BME280, BME680, SHT31 | +| Ciśnienie barometryczne | BME280, BMP280 | +| Rezystancja gazu | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Opis | +| --------------------- | ----------------------------------------------------------------------------- | +| SNR: | Signal-to-Noise Ratio (higher is better) | +| RSSI: | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ------------- | +| > 10 dB | Excellent | +| 0 to 10 dB | dobry | +| -10 to 0 dB | wystarczający | +| < -10 dB | Poor | + +## Metryki zasilania + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Opis | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Natężenie | Power draw in milliamps | +| Zasilanie | Calculated wattage | + +## Pokaż trasę + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Historia pozycji + +Historical position data for nodes that share their location: + +- GPS coordinates +- Wysokość +- Speed (if moving) +- Timestamp for each position report + +## Informacje o sąsiadze + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/pl-rPL/user/nodes.md b/docs/pl-rPL/user/nodes.md new file mode 100644 index 000000000..4f7f94308 --- /dev/null +++ b/docs/pl-rPL/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Węzły +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Węzły + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Rola | Opis | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Klient | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Klient pasywny | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Czujnik | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Pokaż na mapie + - Poproś o pozycję + - Mark as favorite + - Pokaż trasę + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtr | Opis | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Opis | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Poziom naładowania baterii | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Aktywność | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Odległość | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/pl-rPL/user/onboarding.md b/docs/pl-rPL/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/pl-rPL/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/pl-rPL/user/settings-module-admin.md b/docs/pl-rPL/user/settings-module-admin.md new file mode 100644 index 000000000..57fa5f158 --- /dev/null +++ b/docs/pl-rPL/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Konfiguracja modułu + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Opis | +| ----------------- | ------------------------------------------------------------------------ | +| Włączony | Toggle MQTT bridge | +| Serwer | MQTT broker address | +| Nazwa użytkownika | Authentication username | +| Hasło | Authentication password | +| Szyfrowanie | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Opis | +| ---------- | ------------------------------- | +| Włączony | Activate serial communication | +| Echo | Echo received serial data back | +| Tryb | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Opis | +| -------------------------------- | --------------------------- | +| Włączony | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Opis | +| ------------------------------------------ | -------------------------- | +| Włączony | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Wpisów | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Opis | +| -------------------------------------- | --------------------------------- | +| Włączony | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Opis | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Opis | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Wiadomości | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Opis | +| --------------- | -------------------------------- | +| Włączony | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Opis | +| -------------------- | --------------------------------------------------------------- | +| Włączony | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Opis | +| -------------------------------------- | ------------------------------------ | +| Włączony | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Opis | +| ------------------ | ---------------------------------------------------------- | +| Włączony | Activate LED control | +| Stan diody LED | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Opis | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Włączony | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Opis | +| -------------------------------------- | -------------------------- | +| Włączony | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Zarządzanie + +### Zdalne zarządzanie + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Wyczyść bazę węzłów + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Uruchom ponownie + +Remotely reboot a connected or administered node. + +### Panel debugowania + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/pl-rPL/user/settings-radio-user.md b/docs/pl-rPL/user/settings-radio-user.md new file mode 100644 index 000000000..a86042757 --- /dev/null +++ b/docs/pl-rPL/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - ustawienia + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Opis | +| ----------------- | ------------------------------------------------------------------------------------- | +| Długa nazwa | Your display name (up to 39 characters) | +| Krótka nazwa | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Konfiguracja radia + +### Konfiguracja urządzenia + +| Setting | Opis | Domyślny | +| ------------------------------------------ | ----------------------------------------------------------------------- | --------- | +| Rola | Node behavior (Client, Router, etc.) | Klient | +| Tryb retransmisji | How the node retransmits messages | Wszystkie | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Wyłączony | + +### Konfiguracja LoRa + +| Setting | Opis | Domyślny | +| --------------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Region | Regulatory region for frequency bands | Unset (must configure) | +| Ustawienie modemu | Speed/range tradeoff | LongFast | +| Limit przeskoków | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Przesunięcie częstotliwości | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Prędkość | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Konfiguracja wyświetlacza + +| Setting | Opis | +| ---------------------- | ------------------------------------------------------------------------------------ | +| Wygaszenie ekranu | Time before display sleeps | +| Jednostki wyświetlania | Metric or Imperial | +| Typ ekranu OLED | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Konfiguracja pozycjonowania + +| Setting | Opis | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| Interwał aktualizacji pozycji GPS | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Inteligentne Pozycjonowanie | Enable movement-based broadcasting | +| Położenie stałe | Use a manually set position | + +### Konfiguracja zarządzania energią + +| Setting | Opis | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Konfiguracja sieci + +| Setting | Opis | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Hasło do sieci | +| Serwer NTP | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Konfiguracja Bluetooth + +| Setting | Opis | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Tryb parowania | Fixed PIN, Random PIN, or No PIN | +| Stały PIN | PIN code for pairing (default: 123456) | + +### Konfiguracja zabezpieczeń + +| Setting | Opis | +| --------------------- | -------------------------------------------------------------------------- | +| Klucz publiczny | Your node's public key (read-only) | +| Klucz administratora | Key for remote administration | +| Klucz prywatny | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/pl-rPL/user/signal-meter.md b/docs/pl-rPL/user/signal-meter.md new file mode 100644 index 000000000..8a1472d96 --- /dev/null +++ b/docs/pl-rPL/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| dobry | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| wystarczający | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| słaby | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Brak | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/pl-rPL/user/tak.md b/docs/pl-rPL/user/tak.md new file mode 100644 index 000000000..d9a5da07a --- /dev/null +++ b/docs/pl-rPL/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Konfiguracja + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Opis | +| -------- | -------------------------- | +| Włączony | Activate TAK interop | +| Tryb | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Rola | Opis | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Opis | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Rola | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/pl-rPL/user/telemetry-and-sensors.md b/docs/pl-rPL/user/telemetry-and-sensors.md new file mode 100644 index 000000000..ec9dd5f05 --- /dev/null +++ b/docs/pl-rPL/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Opis | Typical Range | +| -------------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Poziom naładowania baterii | Charge percentage | 0–100% | +| Napięcie | Battery voltage | 3.0–4.2V (LiPo) | +| Wykorzystanie kanału | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Czas pracy | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Czujnik | Temperatura | Wilgotność | Ciśnienie | Notatki | +| ------- | ----------- | ---------- | --------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Czujnik | Metric | Notatki | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Czujnik | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Metryki zasilania + +Nodes with INA-series power sensors can report: + +| Metric | Opis | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Natężenie | Power consumption (mA) | +| Zasilanie | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/pl-rPL/user/translate.md b/docs/pl-rPL/user/translate.md new file mode 100644 index 000000000..c07af9c45 --- /dev/null +++ b/docs/pl-rPL/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notatki | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/pl-rPL/user/units-and-locale.md b/docs/pl-rPL/user/units-and-locale.md new file mode 100644 index 000000000..c553996df --- /dev/null +++ b/docs/pl-rPL/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatura + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Wysokość | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Prędkość + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wiatr + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Promieniowanie | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/pt-rBR/index.md b/docs/pt-rBR/index.md new file mode 100644 index 000000000..b93772696 --- /dev/null +++ b/docs/pt-rBR/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Descrição | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/pt-rBR/user/connections.md b/docs/pt-rBR/user/connections.md new file mode 100644 index 000000000..5dda61ffb --- /dev/null +++ b/docs/pt-rBR/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Conexões +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Conexões + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Descrição | +| ---- | -------------- | ----------------------------- | +| 🟢 | Conectado | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Desconectado | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/pt-rBR/user/desktop.md b/docs/pt-rBR/user/desktop.md new file mode 100644 index 000000000..24927bdd4 --- /dev/null +++ b/docs/pt-rBR/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Mapa | ✓ | ✓ | Full parity | +| Configurações | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/pt-rBR/user/discovery.md b/docs/pt-rBR/user/discovery.md new file mode 100644 index 000000000..922275ce6 --- /dev/null +++ b/docs/pt-rBR/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traçar rota + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informações do Vizinho + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/pt-rBR/user/firmware.md b/docs/pt-rBR/user/firmware.md new file mode 100644 index 000000000..18b702636 --- /dev/null +++ b/docs/pt-rBR/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canal | Descrição | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/pt-rBR/user/map-and-waypoints.md b/docs/pt-rBR/user/map-and-waypoints.md new file mode 100644 index 000000000..c8e953645 --- /dev/null +++ b/docs/pt-rBR/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Verde | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Azul | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Descrição | +| ---------- | ------------------------------------------------------- | +| Nome | Short identifier (max 30 characters) | +| Descrição | Optional longer description | +| Icon | Visual marker emoji on the map | +| Bloqueado | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/pt-rBR/user/messages-and-channels.md b/docs/pt-rBR/user/messages-and-channels.md new file mode 100644 index 000000000..e1a5f072a --- /dev/null +++ b/docs/pt-rBR/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Canais + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Segurança do Canal + +Channels support multiple encryption levels: + +| Icon | Security Level | Descrição | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Erro | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Erro | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Tempo esgotado | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Sem interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Nenhum canal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Requisição Inválida | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/pt-rBR/user/mqtt.md b/docs/pt-rBR/user/mqtt.md new file mode 100644 index 000000000..51dba6bd3 --- /dev/null +++ b/docs/pt-rBR/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descrição | Padrão | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Nome de usuário | Broker authentication | meshdev | +| Senha | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Descrição | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Descrição | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/pt-rBR/user/node-metrics.md b/docs/pt-rBR/user/node-metrics.md new file mode 100644 index 000000000..738bef09f --- /dev/null +++ b/docs/pt-rBR/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Descrição | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltagem | Battery voltage reading | +| Utilização do Canal | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatura | BME280, BME680, SHT31 | +| Umidade | BME280, BME680, SHT31 | +| Pressão Barométrica | BME280, BMP280 | +| Resistência ao gás | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Descrição | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Bom | +| -10 to 0 dB | Média | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Descrição | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Atual | Power draw in milliamps | +| Energia | Calculated wattage | + +## Traçar rota + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Log de Posição + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Informações do Vizinho + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/pt-rBR/user/nodes.md b/docs/pt-rBR/user/nodes.md new file mode 100644 index 000000000..8d449862a --- /dev/null +++ b/docs/pt-rBR/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nós +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nós + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Função | Descrição | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Solicitar posição + - Mark as favorite + - Traçar rota + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtro | Descrição | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Descrição | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| --------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Visto pela última vez | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distância | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/pt-rBR/user/onboarding.md b/docs/pt-rBR/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/pt-rBR/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/pt-rBR/user/settings-module-admin.md b/docs/pt-rBR/user/settings-module-admin.md new file mode 100644 index 000000000..bc8d4a146 --- /dev/null +++ b/docs/pt-rBR/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Descrição | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Servidor | MQTT broker address | +| Nome de usuário | Authentication username | +| Senha | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Descrição | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Descrição | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Descrição | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Descrição | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Descrição | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Descrição | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Mensagens | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Descrição | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Descrição | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Descrição | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Descrição | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Descrição | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Descrição | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administração + +### Administração Remota + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Limpar Banco de Dados de Nó + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Reiniciar + +Remotely reboot a connected or administered node. + +### Painel de depuração + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/pt-rBR/user/settings-radio-user.md b/docs/pt-rBR/user/settings-radio-user.md new file mode 100644 index 000000000..fe339fa44 --- /dev/null +++ b/docs/pt-rBR/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - configurações + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Descrição | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Configuração do Dispositivo + +| Setting | Descrição | Padrão | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Função | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### Configuração do LoRa + +| Setting | Descrição | Padrão | +| --------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Região | Regulatory region for frequency bands | Unset (must configure) | +| Predefinição do Modem | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Velocidade | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Configuração da Tela + +| Setting | Descrição | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Configuração da Posição + +| Setting | Descrição | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Configuração de Energia + +| Setting | Descrição | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Configuração de Rede + +| Setting | Descrição | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Configuração do Bluetooth + +| Setting | Descrição | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| PIN fixo | PIN code for pairing (default: 123456) | + +### Configurações de Segurança + +| Setting | Descrição | +| ---------------------- | -------------------------------------------------------------------------- | +| Chave Publica | Your node's public key (read-only) | +| Chave do Administrador | Key for remote administration | +| Chave Privada | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Modo Administrado | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/pt-rBR/user/signal-meter.md b/docs/pt-rBR/user/signal-meter.md new file mode 100644 index 000000000..94971bb71 --- /dev/null +++ b/docs/pt-rBR/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------ | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Bom | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Média | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Ruim | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Nenhum | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/pt-rBR/user/tak.md b/docs/pt-rBR/user/tak.md new file mode 100644 index 000000000..108b78556 --- /dev/null +++ b/docs/pt-rBR/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descrição | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Função | Descrição | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Descrição | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Função | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/pt-rBR/user/telemetry-and-sensors.md b/docs/pt-rBR/user/telemetry-and-sensors.md new file mode 100644 index 000000000..c45c87dc9 --- /dev/null +++ b/docs/pt-rBR/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Descrição | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltagem | Battery voltage | 3.0–4.2V (LiPo) | +| Utilização do Canal | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatura | Umidade | Pressão | Notes | +| ------- | ----------- | ------- | ------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Descrição | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Atual | Power consumption (mA) | +| Energia | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/pt-rBR/user/translate.md b/docs/pt-rBR/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/pt-rBR/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/pt-rBR/user/units-and-locale.md b/docs/pt-rBR/user/units-and-locale.md new file mode 100644 index 000000000..173f2a153 --- /dev/null +++ b/docs/pt-rBR/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatura + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Velocidade + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Vento + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiação | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/pt-rPT/index.md b/docs/pt-rPT/index.md new file mode 100644 index 000000000..b93772696 --- /dev/null +++ b/docs/pt-rPT/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Descrição | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/pt-rPT/user/connections.md b/docs/pt-rPT/user/connections.md new file mode 100644 index 000000000..30a679ef2 --- /dev/null +++ b/docs/pt-rPT/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Ligações +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Ligações + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Descrição | +| ---- | -------------- | ----------------------------- | +| 🟢 | Ligado | Active radio link established | +| 🟡 | A ligar | Handshake in progress | +| 🔴 | Desconectado | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuração + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/pt-rPT/user/desktop.md b/docs/pt-rPT/user/desktop.md new file mode 100644 index 000000000..99e99f2f8 --- /dev/null +++ b/docs/pt-rPT/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Mapa | ✓ | ✓ | Full parity | +| Definições | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/pt-rPT/user/discovery.md b/docs/pt-rPT/user/discovery.md new file mode 100644 index 000000000..31f94a79b --- /dev/null +++ b/docs/pt-rPT/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traçar rota + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informações da vizinhança + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/pt-rPT/user/firmware.md b/docs/pt-rPT/user/firmware.md new file mode 100644 index 000000000..18b702636 --- /dev/null +++ b/docs/pt-rPT/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canal | Descrição | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/pt-rPT/user/map-and-waypoints.md b/docs/pt-rPT/user/map-and-waypoints.md new file mode 100644 index 000000000..c8e953645 --- /dev/null +++ b/docs/pt-rPT/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Verde | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Azul | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Descrição | +| ---------- | ------------------------------------------------------- | +| Nome | Short identifier (max 30 characters) | +| Descrição | Optional longer description | +| Icon | Visual marker emoji on the map | +| Bloqueado | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/pt-rPT/user/messages-and-channels.md b/docs/pt-rPT/user/messages-and-channels.md new file mode 100644 index 000000000..8382e302f --- /dev/null +++ b/docs/pt-rPT/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Canal + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Descrição | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Erros | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Erros | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Sem interface | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Sem canal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Pedido Inválido | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/pt-rPT/user/mqtt.md b/docs/pt-rPT/user/mqtt.md new file mode 100644 index 000000000..1443b9de4 --- /dev/null +++ b/docs/pt-rPT/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuração + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descrição | Predefinição | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Utilizador | Broker authentication | meshdev | +| Palavra-passe | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Descrição | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Descrição | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/pt-rPT/user/node-metrics.md b/docs/pt-rPT/user/node-metrics.md new file mode 100644 index 000000000..076ff8f2c --- /dev/null +++ b/docs/pt-rPT/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Descrição | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltagem | Battery voltage reading | +| Utilização do canal | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Tempo ativo | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatura | BME280, BME680, SHT31 | +| Humidade | BME280, BME680, SHT31 | +| Pressão atmosférica | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Descrição | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Bom | +| -10 to 0 dB | Razoável | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Descrição | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Atual | Power draw in milliamps | +| Energia | Calculated wattage | + +## Traçar rota + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Histórico de posição + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Informações da vizinhança + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/pt-rPT/user/nodes.md b/docs/pt-rPT/user/nodes.md new file mode 100644 index 000000000..3ba2be1e6 --- /dev/null +++ b/docs/pt-rPT/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Papel | Descrição | +| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Cliente | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Cliente silenciado | Receives but doesn't retransmit | +| Cliente oculto | Like Client Mute, plus hides from node list | +| Roteador | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Monitor | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK — ‘Kit’ de Consciencialização da Equipa | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Solicitar posição + - Mark as favorite + - Traçar rota + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtrar | Descrição | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Descrição | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| --------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Último recebido | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distância | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/pt-rPT/user/onboarding.md b/docs/pt-rPT/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/pt-rPT/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/pt-rPT/user/settings-module-admin.md b/docs/pt-rPT/user/settings-module-admin.md new file mode 100644 index 000000000..a43a4b84b --- /dev/null +++ b/docs/pt-rPT/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Descrição | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Servidor | MQTT broker address | +| Utilizador | Authentication username | +| Palavra-passe | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Descrição | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Descrição | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Descrição | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Descrição | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Descrição | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Descrição | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Mensagens | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Descrição | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Descrição | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Descrição | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Descrição | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Descrição | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Descrição | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administração + +### Administração Remota + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Reiniciar + +Remotely reboot a connected or administered node. + +### Painel de depuração + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/pt-rPT/user/settings-radio-user.md b/docs/pt-rPT/user/settings-radio-user.md new file mode 100644 index 000000000..d2bad6967 --- /dev/null +++ b/docs/pt-rPT/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - definições + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Descrição | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Configuração do Dispositivo + +| Setting | Descrição | Predefinição | +| ------------------------------------------ | ----------------------------------------------------------------------- | ------------ | +| Papel | Node behavior (Client, Router, etc.) | Cliente | +| Rebroadcast Mode | How the node retransmits messages | Tudo | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### Configuração de LoRa + +| Setting | Descrição | Predefinição | +| --------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Região | Regulatory region for frequency bands | Unset (must configure) | +| Predefinição de modem | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Configuração do Ecrã + +| Setting | Descrição | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Configuração da posição + +| Setting | Descrição | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Posição Inteligente | Enable movement-based broadcasting | +| Posição fixa | Use a manually set position | + +### Configuração de Energia + +| Setting | Descrição | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Configuração de Rede + +| Setting | Descrição | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Configuração de Bluetooth + +| Setting | Descrição | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| PIN fixo | PIN code for pairing (default: 123456) | + +### Configuração de Segurança + +| Setting | Descrição | +| ---------------------- | -------------------------------------------------------------------------- | +| Chave pública | Your node's public key (read-only) | +| Chave do Administrador | Key for remote administration | +| Chave privada | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Modo Administrado | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/pt-rPT/user/signal-meter.md b/docs/pt-rPT/user/signal-meter.md new file mode 100644 index 000000000..78f7b718f --- /dev/null +++ b/docs/pt-rPT/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| -------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Bom | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Razoável | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Mau | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Nenhum | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/pt-rPT/user/tak.md b/docs/pt-rPT/user/tak.md new file mode 100644 index 000000000..621b64081 --- /dev/null +++ b/docs/pt-rPT/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuração + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descrição | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Papel | Descrição | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Descrição | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Papel | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/pt-rPT/user/telemetry-and-sensors.md b/docs/pt-rPT/user/telemetry-and-sensors.md new file mode 100644 index 000000000..0e5976f0e --- /dev/null +++ b/docs/pt-rPT/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Descrição | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltagem | Battery voltage | 3.0–4.2V (LiPo) | +| Utilização do canal | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Tempo ativo | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatura | Humidade | Pressão | Notes | +| ------- | ----------- | -------- | ------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Descrição | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Atual | Power consumption (mA) | +| Energia | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/pt-rPT/user/translate.md b/docs/pt-rPT/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/pt-rPT/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/pt-rPT/user/units-and-locale.md b/docs/pt-rPT/user/units-and-locale.md new file mode 100644 index 000000000..9cb1bb6ad --- /dev/null +++ b/docs/pt-rPT/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatura + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Vento + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiação | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/ro-rRO/index.md b/docs/ro-rRO/index.md new file mode 100644 index 000000000..e60717668 --- /dev/null +++ b/docs/ro-rRO/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Descriere | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/ro-rRO/user/connections.md b/docs/ro-rRO/user/connections.md new file mode 100644 index 000000000..46d60268a --- /dev/null +++ b/docs/ro-rRO/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Descriere | +| ---- | -------------- | ----------------------------- | +| 🟢 | Conectat | Active radio link established | +| 🟡 | Conectare | Handshake in progress | +| 🔴 | Deconectat | No active connection | +| ⚪ | Not configured | Nici un dispozitiv selectat | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ro-rRO/user/desktop.md b/docs/ro-rRO/user/desktop.md new file mode 100644 index 000000000..0a188d5ac --- /dev/null +++ b/docs/ro-rRO/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notițe | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Setări | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ro-rRO/user/discovery.md b/docs/ro-rRO/user/discovery.md new file mode 100644 index 000000000..d87572d37 --- /dev/null +++ b/docs/ro-rRO/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Descoperiți +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Descoperiți + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Trasare traseu + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informații vecin + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ro-rRO/user/firmware.md b/docs/ro-rRO/user/firmware.md new file mode 100644 index 000000000..fcff78748 --- /dev/null +++ b/docs/ro-rRO/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Canal | Descriere | +| ------ | ------------------------------------------- | +| Stabil | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ro-rRO/user/map-and-waypoints.md b/docs/ro-rRO/user/map-and-waypoints.md new file mode 100644 index 000000000..73033544a --- /dev/null +++ b/docs/ro-rRO/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| -------- | ---------------------------------------------- | +| Verde | Online (heard recently) | +| Galben | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Albastru | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Descriere | +| ---------- | ------------------------------------------------------- | +| Nume | Short identifier (max 30 characters) | +| Descriere | Optional longer description | +| Icon | Visual marker emoji on the map | +| Blocat | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ro-rRO/user/messages-and-channels.md b/docs/ro-rRO/user/messages-and-channels.md new file mode 100644 index 000000000..02fa5f062 --- /dev/null +++ b/docs/ro-rRO/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Canale + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Securitate canal + +Channels support multiple encryption levels: + +| Icon | Security Level | Descriere | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Eroare | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Eroare | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Expirat | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Fără interfață | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Niciun canal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Niciun raspuns | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Solicitare invalidă | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ro-rRO/user/mqtt.md b/docs/ro-rRO/user/mqtt.md new file mode 100644 index 000000000..79cad72dc --- /dev/null +++ b/docs/ro-rRO/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descriere | Prestabilit | +| ------------------ | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Nume de utilizator | Broker authentication | meshdev | +| Parolă | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Activat | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Descriere | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Descriere | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ro-rRO/user/node-metrics.md b/docs/ro-rRO/user/node-metrics.md new file mode 100644 index 000000000..7faba541e --- /dev/null +++ b/docs/ro-rRO/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Valori dispozitiv + +Basic operating information reported by each node: + +| Metric | Descriere | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Tensiune | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Timp de functionare | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Indicatori de mediu + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperature | BME280, BME680, SHT31 | +| Humidity | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Rezistența la gaz | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Descriere | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ---------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Bun | +| -10 to 0 dB | Acceptabil | +| < -10 dB | Poor | + +## Valori putere + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Descriere | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Actual | Power draw in milliamps | +| Alimentare | Calculated wattage | + +## Trasare traseu + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Log + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitudine +- Speed (if moving) +- Timestamp for each position report + +## Informații vecin + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ro-rRO/user/nodes.md b/docs/ro-rRO/user/nodes.md new file mode 100644 index 000000000..73a68b185 --- /dev/null +++ b/docs/ro-rRO/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Noduri +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Noduri + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Descriere | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client bază | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client mut | Receives but doesn't retransmit | +| Client ascuns | Like Client Mute, plus hides from node list | +| Ruter | Prioritizes message forwarding; stays awake to relay | +| Ruter cu întârziere | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Senzor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| Tracker TAK | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Vizualizați pe hartă + - Solicită poziția + - Mark as favorite + - Trasare traseu + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtru | Descriere | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Descriere | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| --------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Ultima recepție | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distanță | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ro-rRO/user/onboarding.md b/docs/ro-rRO/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ro-rRO/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ro-rRO/user/settings-module-admin.md b/docs/ro-rRO/user/settings-module-admin.md new file mode 100644 index 000000000..56eb532c9 --- /dev/null +++ b/docs/ro-rRO/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Descriere | +| ------------------ | ------------------------------------------------------------------------ | +| Activat | Toggle MQTT bridge | +| Server | MQTT broker address | +| Nume de utilizator | Authentication username | +| Parolă | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Descriere | +| ---------- | ------------------------------- | +| Activat | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Descriere | +| -------------------------------- | --------------------------- | +| Activat | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Descriere | +| ------------------------------------------ | -------------------------- | +| Activat | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Descriere | +| -------------------------------------- | --------------------------------- | +| Activat | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Descriere | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Descriere | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Mesaje | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Descriere | +| --------------- | -------------------------------- | +| Activat | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Descriere | +| -------------------- | --------------------------------------------------------------- | +| Activat | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Descriere | +| -------------------------------------- | ------------------------------------ | +| Activat | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Descriere | +| ------------------ | ---------------------------------------------------------- | +| Activat | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Descriere | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Activat | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Descriere | +| -------------------------------------- | -------------------------- | +| Activat | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administrare + +### Administrare la distanță + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Curăță baza de date a nodurilor + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Restartează + +Remotely reboot a connected or administered node. + +### Panou de depanare + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ro-rRO/user/settings-radio-user.md b/docs/ro-rRO/user/settings-radio-user.md new file mode 100644 index 000000000..defa3e6e4 --- /dev/null +++ b/docs/ro-rRO/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - setari + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Descriere | +| ----------------- | ------------------------------------------------------------------------------------- | +| Nume lung | Your display name (up to 39 characters) | +| Nume scurt | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Descriere | Prestabilit | +| ------------------------------------------ | ----------------------------------------------------------------------- | ----------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Mod de redifuzare | How the node retransmits messages | Toate | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Descriere | Prestabilit | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regiune | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Viteza | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Descriere | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Descriere | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Poziție inteligentă | Enable movement-based broadcasting | +| Poziție fixă | Use a manually set position | + +### Configurare Putere + +| Setting | Descriere | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Descriere | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Configurare Bluetooth + +| Setting | Descriere | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| PIN fix | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Descriere | +| --------------------- | -------------------------------------------------------------------------- | +| Chei publice | Your node's public key (read-only) | +| Cheie Administrator | Key for remote administration | +| Cheia privată | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Mod Gestionat | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ro-rRO/user/signal-meter.md b/docs/ro-rRO/user/signal-meter.md new file mode 100644 index 000000000..d65e86d7f --- /dev/null +++ b/docs/ro-rRO/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ---------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Bun | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Acceptabil | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Slab | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Niciunul | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ro-rRO/user/tak.md b/docs/ro-rRO/user/tak.md new file mode 100644 index 000000000..21c9357f8 --- /dev/null +++ b/docs/ro-rRO/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Descriere | +| ------- | -------------------------- | +| Activat | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Descriere | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Descriere | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ro-rRO/user/telemetry-and-sensors.md b/docs/ro-rRO/user/telemetry-and-sensors.md new file mode 100644 index 000000000..18fb4b47d --- /dev/null +++ b/docs/ro-rRO/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Descriere | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Tensiune | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Timp de functionare | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Senzor | Temperature | Humidity | Presiune | Notițe | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Senzor | Metric | Notițe | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Senzor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Valori putere + +Nodes with INA-series power sensors can report: + +| Metric | Descriere | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Actual | Power consumption (mA) | +| Alimentare | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ro-rRO/user/translate.md b/docs/ro-rRO/user/translate.md new file mode 100644 index 000000000..ece3a6051 --- /dev/null +++ b/docs/ro-rRO/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notițe | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/ro-rRO/user/units-and-locale.md b/docs/ro-rRO/user/units-and-locale.md new file mode 100644 index 000000000..1c5136c1c --- /dev/null +++ b/docs/ro-rRO/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperature + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitudine | +| -------------------------------- | -------------- | ---------------------- | ---------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Viteza + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Vânt + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiație | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/ru-rRU/index.md b/docs/ru-rRU/index.md new file mode 100644 index 000000000..05858a067 --- /dev/null +++ b/docs/ru-rRU/index.md @@ -0,0 +1,30 @@ +--- +title: Домой +layout: default +nav_order: 0 +--- + +# Документация приложения Meshtastic Android + +Документация для пользователей и разработчиков приложения Meshtastic на Android, ПК и iOS, работающих на KMP (Kotlin Multiplatform). + +Используйте боковую панель навигации, чтобы просматривать **Руководство пользователя** по функциям приложения и **Руководство разработчика** по внесению вклада в проект. + +--- + +## Быстрые ссылки + +| Руководство | Описание | +| ------------------------------------------------------------------------------ | ----------------------------------------------------------------- | +| [Начало работы](user/onboarding) | Подключите вашу первую радиостанцию и отправьте сообщение | +| [Сообщения и Каналы](user/messages-and-channels) | Широковещательный канал, прямые сообщения, реакции и шифрование | +| [Ноды](user/nodes) | Понимание списка узлов mesh-сети | +| [Индикатор сигнала](user/signal-meter) | Как работает индикатор для измерения качества сигнала LoRa | +| [Ед.изм. и локализация](user/units-and-locale) | Как температуру, расстояние и время адаптировать к вашему региону | +| [Десктопное приложение](user/desktop) | Использование настольных систем Linux, macOS и Windows | +| [Архитектура](developer/architecture) | Обзор архитектуры приложения для участников | +| [Вклад](developer/contributing) | Именование веток, рабочий процесс PR и команды проверки | + +--- + +> Эта документация предоставляется из того же источника Markdown, который обеспечивает работу встроенного браузера **Справка и документация**. diff --git a/docs/ru-rRU/user/connections.md b/docs/ru-rRU/user/connections.md new file mode 100644 index 000000000..0c30e6264 --- /dev/null +++ b/docs/ru-rRU/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Соединения +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Соединения + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Описание | +| ---- | -------------- | ----------------------------- | +| 🟢 | Подключено | Active radio link established | +| 🟡 | Подключение | Handshake in progress | +| 🔴 | Отключено | No active connection | +| ⚪ | Not configured | Устройство не выбрано | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Настройки + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/ru-rRU/user/desktop.md b/docs/ru-rRU/user/desktop.md new file mode 100644 index 000000000..5f7f919b0 --- /dev/null +++ b/docs/ru-rRU/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Настольное приложение +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Настольное приложение + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Обзор + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Установка + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Заметки | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Обмен сообщениями | ✓ | ✓ | Полное равенство | +| Список нод | ✓ | ✓ | Полное равенство | +| Карта | ✓ | ✓ | Полное равенство | +| Настройки | ✓ | ✓ | Полное равенство | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Виджеты | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/ru-rRU/user/discovery.md b/docs/ru-rRU/user/discovery.md new file mode 100644 index 000000000..b811f1ef2 --- /dev/null +++ b/docs/ru-rRU/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Обнаружение +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Обнаружение + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Трассировка маршрута + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Информация об окружении + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/ru-rRU/user/firmware.md b/docs/ru-rRU/user/firmware.md new file mode 100644 index 000000000..8a9b01a56 --- /dev/null +++ b/docs/ru-rRU/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Канал | Описание | +| ---------- | ------------------------------------------- | +| Стабильная | Recommended for most users; tested releases | +| Альфа | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ru-rRU/user/map-and-waypoints.md b/docs/ru-rRU/user/map-and-waypoints.md new file mode 100644 index 000000000..a425e7ce2 --- /dev/null +++ b/docs/ru-rRU/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------- | ---------------------------------------------- | +| Зеленый | Online (heard recently) | +| Жёлтый | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Синий | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Описание | +| ------------- | ------------------------------------------------------- | +| Имя | Short identifier (max 30 characters) | +| Описание | Optional longer description | +| Icon | Visual marker emoji on the map | +| Заблокировано | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/ru-rRU/user/messages-and-channels.md b/docs/ru-rRU/user/messages-and-channels.md new file mode 100644 index 000000000..eb339d27f --- /dev/null +++ b/docs/ru-rRU/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Каналы + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Безопасность канала + +Channels support multiple encryption levels: + +| Icon | Security Level | Описание | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Доставлено | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Ошибки | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Ошибки | Meaning | What to Do | +| ---------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Время ожидания истекло | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Нет интерфейса | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Нет канала | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Без ответа | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Неверный запрос | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/ru-rRU/user/mqtt.md b/docs/ru-rRU/user/mqtt.md new file mode 100644 index 000000000..4a0343578 --- /dev/null +++ b/docs/ru-rRU/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Обзор + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## Как это работает + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Настройки + +### Включение MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Настройка | Описание | По умолчанию | +| ---------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Адрес сервера | MQTT broker hostname | mqtt.meshtastic.org | +| Имя пользователя | Broker authentication | meshdev | +| Пароль | Broker authentication | large4cats | +| Корневая тема | Base topic for messages | msh | +| Шифрование | Encrypt MQTT payload | Включено | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Отключено | +| TLS | Secure connection to broker | Отключено | +| Map Reporting | Report position to public map | Отключено | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Описание | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Описание | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/ru-rRU/user/node-metrics.md b/docs/ru-rRU/user/node-metrics.md new file mode 100644 index 000000000..ab06c0e06 --- /dev/null +++ b/docs/ru-rRU/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Интервал передачи + +Basic operating information reported by each node: + +| Metric | Описание | +| -------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Напряжение | Battery voltage reading | +| Использование канала | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Аптайм | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Метрики окружения + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Температура | BME280, BME680, SHT31 | +| Влажность | BME280, BME680, SHT31 | +| Давление на барометре | BME280, BMP280 | +| Сопротивление газа | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Показатели сигнала + +Radio signal quality information: + +| Metric | Описание | +| ---------- | ----------------------------------------------------------------------------- | +| Сигнал/шум | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Хороший | +| -10 to 0 dB | Средний | +| < -10 dB | Poor | + +## Метрики питания + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Описание | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Ток | Power draw in milliamps | +| Питание | Calculated wattage | + +## Трассировка маршрута + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Журнал местоположения + +Historical position data for nodes that share their location: + +- GPS coordinates +- Высота +- Speed (if moving) +- Timestamp for each position report + +## Информация об окружении + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/ru-rRU/user/nodes.md b/docs/ru-rRU/user/nodes.md new file mode 100644 index 000000000..e59dcb2a2 --- /dev/null +++ b/docs/ru-rRU/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Ноды +nav_order: 4 +last_updated: 2026-05-13 +description: Просматривайте, фильтруйте и сортируйте ноды сети — просматривайте подробности, качество сигнала, роли и быстрые действия. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Ноды + +The Nodes screen displays all devices visible on your mesh network. + +## Список узлов + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ----------- | ------------------------------------- | +| 🟢 Онлайн | Node heard within the last 15 minutes | +| 🟡 Отошёл | Node heard within the last 2 hours | +| 🔴 Отключен | Node not heard for over 2 hours | +| ⭐ Избранный | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Роль | Описание | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| Тактический | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Выбор роли + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Показать на карте + - Запросить позицию + - Mark as favorite + - Трассировка маршрута + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Фильтр | Описание | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Описание | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ---------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Уровень заряда батареи | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Последний раз слышен | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Расстояние | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/ru-rRU/user/onboarding.md b/docs/ru-rRU/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/ru-rRU/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/ru-rRU/user/settings-module-admin.md b/docs/ru-rRU/user/settings-module-admin.md new file mode 100644 index 000000000..33fb18a21 --- /dev/null +++ b/docs/ru-rRU/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Настройки — Модули и администрирование +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Настройки — Модули и администрирование + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Конфигурация модуля + +### Модуль MQTT + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Настройка | Описание | +| ---------------- | ------------------------------------------------------------------------ | +| Включено | Toggle MQTT bridge | +| Сервер | MQTT broker address | +| Имя пользователя | Authentication username | +| Пароль | Authentication password | +| Шифрование | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Корневая тема | Base MQTT topic path | +| Отчет карты | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Настройка | Описание | +| ------------------------------------------ | ------------------------------- | +| Включено | Activate serial communication | +| Эхо | Echo received serial data back | +| Режим обмена | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Скорость передачи (бод) | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Настройка | Описание | +| ----------------------------------------- | --------------------------- | +| Включено | Activate notifications | +| Включить уведомление о входящем сообщении | Notify on incoming messages | +| Зуммер при уведомлении | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Уведомлять при 🔔 | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Активный выход | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Описание | +| ------------------------------------------ | -------------------------- | +| Включено | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Записи | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Описание | +| -------------------------------------- | --------------------------------- | +| Включено | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Описание | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Телеметрия воздуха | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Описание | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Сообщения | Newline-separated list of messages | +| Отправлять 🔔 | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Описание | +| --------------- | -------------------------------- | +| Включено | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Описание | +| -------------------- | --------------------------------------------------------------- | +| Включено | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Описание | +| -------------------------------------- | ------------------------------------ | +| Включено | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Описание | +| -------------------- | ---------------------------------------------------------- | +| Включено | Activate LED control | +| Состояние светодиода | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Описание | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Включено | Activate detection sensor | +| Пин датчика | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Отправлять 🔔 | Include bell character in alerts | +| Имя датчика | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Описание | +| -------------------------------------- | -------------------------- | +| Включено | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Администрирование + +### Удаленное администрирование + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Очистить базу данных нод + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Перезагрузка + +Remotely reboot a connected or administered node. + +### Панель отладки + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/ru-rRU/user/settings-radio-user.md b/docs/ru-rRU/user/settings-radio-user.md new file mode 100644 index 000000000..9b6c8823d --- /dev/null +++ b/docs/ru-rRU/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Настройки - Радио и пользователь +nav_order: 7 +last_updated: 2026-05-13 +description: Настройте ваше радиоустройство, пресеты LoRa, пользовательский профиль, обмен местоположением, управление питанием и безопасность. +aliases: + - настройки + - radio-config + - user-config + - lora +--- + +# Настройки - Радио и пользователь + +Настройте радиоустройство и параметры идентификации пользователя. + +## Настройки пользователя + +### Профиль пользователя + +| Настройка | Описание | +| ------------------------ | ------------------------------------------------------------------------------------------------------------------- | +| Полное имя | Ваше отображаемое имя (до 39 символов) | +| Короткое имя | 4-символьное сокращённое имя | +| Лицензированный оператор | Включите, если у вас есть лицензия радиолюбителя (позволяет использовать более высокую мощность) | + +### Применение изменений + +После изменения настроек нажмите **Сохранить** чтобы записать конфигурацию в ваше радиоустройство. Устройство может перезагрузиться для применения изменений. + +## Конфигурация радио + +### Настройки устройства + +| Настройка | Описание | По умолчанию | +| ------------------------------------------ | ----------------------------------------------------------------------------------------- | ------------ | +| Роль | Поведение ноды (Client, Router и т.д.) | Client | +| Режим ретрансляции | Как нода повторно передает сообщения | Всё | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Двойное нажатие кнопки | Action for double-tap button press | Включено | + +### Настройка LoRa + +| Настройка | Описание | По умолчанию | +| ------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------- | +| Регион / Страна | Regulatory region for frequency bands | Unset (must configure) | +| Режим работы модема | Speed/range tradeoff | LongFast | +| Лимит хопов | Maximum retransmit hops | 3 | +| Мощность передачи | Мощность передачи (дБм); 0 = максимально разрешённая для региона | 0 (максимум региона) | +| Частотное смещение | Точная настройка частоты (МГц) | 0 | +| Полоса пропускания канала | Настройка пропускной способности | По умолчанию для предустановки | + +> ⚠️ **Важно:** Вы **обязаны** установить свой регион перед отправкой. Работа без правильного региона может нарушать местные правила радиопользования. Смотрите [руководство по настройке региона](https://meshtastic.org/docs/getting-started/initial-config) на сайте meshtastic.org для получения подробной информации. + +### Предустановки модема + +| Предустановка | Диапазон | Скорость | Предел SNR | Лучше всего для | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 км | 21.9 кб/с | −5 дБ | Плотная городская застройка с прямой видимостью; приложения, требующие высокой передачи данных | +| Short Fast | ~3 км | 10.9 кб/с | −7.5 дБ | Городские районы; здания в пределах нескольких кварталов | +| Short Slow | ~5 км | 5.5 кб/с | -10 дБ | Suburban short-range; moderate building density | +| Medium Fast | ~5 км | 5.5 кб/с | -10 дБ | Пригородные районы; умеренная плотность застройки | +| Medium Slow | ~8 km | 1.1 кб/с | −12.5 дБ | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 км | 4.4 kbps | -10 дБ | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 км | 1.1 кб/с | −12.5 дБ | **Общее использование (по умолчанию)** — сбалансированный диапазон и скорость | +| Long Moderate | ~20 км | 0.34 кб/с | -15 дБ | Сельская местность с некоторым рельефом; случайное использование | +| Lite Fast | ~5 км | 5.5 кб/с | -10 дБ | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 км | 1.1 кб/с | −12.5 дБ | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 км | 2.7 kbps | -10 дБ | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 км | 1.1 кб/с | −12.5 дБ | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 км | 0.18 кб/с | −17.5 дБ | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ км | 0.09 кб/с | −20 дБ | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Выбор предустановки модема + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Параметры дисплея + +| Настройка | Описание | +| ------------------- | ------------------------------------------------------------------------------------ | +| Время ожидания | Время до перехода в спящий режим | +| Единицы измерения | Метрическая или имперская | +| Тип OLED-дисплея | Авто, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Настройки местоположения + +| Настройка | Описание | +| ----------------------- | --------------------------------------- | +| GPS включен | Включение/отключение GPS | +| Интервал обновления GPS | Как часто получать GPS-фиксацию | +| Вещание позиции | How often to share position | +| Умная позиция | Enable movement-based broadcasting | +| Фиксированная позиция | Использовать вручную заданное положение | + +### Настройка питания + +| Настройка | Описание | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| Множитель ADC | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Настройка сети + +| Настройка | Описание | +| ------------- | --------------------------------------------------------------- | +| WiFi включен | Включить радиомодуль WiFi (устройства ESP32) | +| WiFi SSID | Имя сети для подключения | +| WiFi PSK | Пароль сети | +| NTP-сервер | Сервер синхронизации времени | +| Syslog-сервер | Удалённый сервер логирования | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Настройка Bluetooth + +| Setting | Описание | +| --------------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Фиксированный PIN-код | PIN code for pairing (default: 123456) | + +### Настройки безопасности + +| Setting | Описание | +| --------------------- | -------------------------------------------------------------------------- | +| Публичный ключ | Your node's public key (read-only) | +| Ключ администратора | Key for remote administration | +| Приватный ключ | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Журнал отладки | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Управляемый режим | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/ru-rRU/user/signal-meter.md b/docs/ru-rRU/user/signal-meter.md new file mode 100644 index 000000000..100d7e5a0 --- /dev/null +++ b/docs/ru-rRU/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Хороший | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Средний | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Плохой | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Отсутствует | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/ru-rRU/user/tak.md b/docs/ru-rRU/user/tak.md new file mode 100644 index 000000000..178779555 --- /dev/null +++ b/docs/ru-rRU/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Настройки + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Описание | +| ------------ | -------------------------- | +| Включено | Activate TAK interop | +| Режим обмена | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Роль | Описание | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Описание | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Роль | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/ru-rRU/user/telemetry-and-sensors.md b/docs/ru-rRU/user/telemetry-and-sensors.md new file mode 100644 index 000000000..ddedeae37 --- /dev/null +++ b/docs/ru-rRU/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Описание | Typical Range | +| -------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Напряжение | Battery voltage | 3.0–4.2V (LiPo) | +| Использование канала | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Аптайм | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Температура | Влажность | Давление | Заметки | +| ------- | ----------- | --------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Заметки | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Метрики питания + +Nodes with INA-series power sensors can report: + +| Metric | Описание | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Ток | Power consumption (mA) | +| Питание | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/ru-rRU/user/translate.md b/docs/ru-rRU/user/translate.md new file mode 100644 index 000000000..0bd3e1728 --- /dev/null +++ b/docs/ru-rRU/user/translate.md @@ -0,0 +1,96 @@ +--- +title: Перевод приложения +parent: Руководство пользователя +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Перевод приложения + +Внесение вклада в перевод помогает сделать Meshtastic доступным для более широкой аудитории. Приложение использует [Crowdin](https://crowdin.com/) для управления переводами сообщества как для пользовательского интерфейса, так и для документации в приложении. + +--- + +## Что переводится + +| Ресурс | Исходное местоположение | Заметки | +| --------------------------------- | ------------------------------------- | ------------------------------------------------------------------------ | +| Строки интерфейса | `composeResources/values/strings.xml` | Кнопки, ярлыки, сообщения и весь видимый пользователю текст | +| Страницы руководства пользователя | `docs/user/*.md` | Встроенная документация, отображаемая в разделе «Справка и документация» | +| Метаданные Fastlane | `fastlane/metadata/android/en-US/` | Название, описание и журналы изменений в App Store | + +> **Примечание — страницы руководства для разработчиков доступны только на английском языке.** Документация, ориентированная на код и предназначенная для контрибьюторов, не переводится. + +--- + +## Как внести вклад + +1. **Посетите проект Crowdin.** Откройте [проект Meshtastic Android на Crowdin](https://crowdin.com/project/meshtastic-android) и войдите в систему или создайте бесплатный аккаунт. +2. **Выберите свой язык.** Выберите существующий язык или запросите новый, открыв [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Переводите строки.** Crowdin показывает английский исходный текст слева и ваш перевод справа. Переведите каждую строку и сохраните. +4. **Проверьте контекст.** Многие строки содержат скриншоты или комментарии о контексте — проверьте их, чтобы понять, где данный текст появляется в приложении. +5. **Отправьте.** Одобренные переводы автоматически включаются в следующий выпуск. + +> **Совет — делайте переводы короткими.** Строки интерфейса часто появляются на кнопках, ярлыках или в узких колонках. Если перевод значительно длиннее английского оригинала, рассмотрите возможность сокращения, чтобы смысл оставался понятным. + +--- + +## Добавление нового языка + +Если твоего языка еще нет в списке на Crowdin: + +1. Открой задачу на [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) для запроса нового языка. +2. Поддерживающий добавит язык в Crowdin и настроит `crowdin.yml`. +3. После добавления вы можете начать переводить сразу. + +--- + +## Как организованы переводы + +Приложение для Android использует **Compose Multiplatform resources** для всех строк, видимых пользователю: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +Встроенная документация следует аналогичной схеме в папке `docs/`: + +``` +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +Приложение автоматически выбирает правильную локаль на основе настроек **Язык и регион** вашего устройства. + +--- + +## Руководство по переводу + +- **Не переводите** технические термины, такие как "LoRa", "MQTT", "BLE", "TAK", "SNR" или "RSSI" — они универсальны. +- **Сохраняйте заполнители без изменений.** Строки, такие как `%1$s` или `%d`, заполняются во время выполнения. Не удаляйте и не меняйте их порядок, если только грамматика вашего языка не требует этого. +- **Согласуйте тон.** Приложение использует дружелюбный, прямой стиль общения. Избегайте чрезмерно официального языка. +- **Проверьте, если возможно.** Измените язык устройства и откройте приложение, чтобы увидеть, как переводы выглядят в контексте. + +--- + +## Вопросы? + +Если у вас есть вопросы о контексте конкретной строки или вам нужна помощь с началом работы, откройте обсуждение на странице [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions). + +Спасибо за помощь в расширении охвата Meshtastic! diff --git a/docs/ru-rRU/user/units-and-locale.md b/docs/ru-rRU/user/units-and-locale.md new file mode 100644 index 000000000..191fcbc98 --- /dev/null +++ b/docs/ru-rRU/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Температура + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Высота | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Скорость + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Ветер + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Радиация | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/sk-rSK/index.md b/docs/sk-rSK/index.md new file mode 100644 index 000000000..99b032289 --- /dev/null +++ b/docs/sk-rSK/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Popis | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/sk-rSK/user/connections.md b/docs/sk-rSK/user/connections.md new file mode 100644 index 000000000..56d01abf0 --- /dev/null +++ b/docs/sk-rSK/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Popis | +| ---- | ------------------- | -------------------------------- | +| 🟢 | Pripojený | Active radio link established | +| 🟡 | Prebieha pripájanie | Handshake in progress | +| 🔴 | Odpojené | No active connection | +| ⚪ | Not configured | Nebolo vybrané žiadne zariadenie | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/sk-rSK/user/desktop.md b/docs/sk-rSK/user/desktop.md new file mode 100644 index 000000000..265761118 --- /dev/null +++ b/docs/sk-rSK/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Mapa | ✓ | ✓ | Full parity | +| Nastavenia | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/sk-rSK/user/discovery.md b/docs/sk-rSK/user/discovery.md new file mode 100644 index 000000000..d4effed7f --- /dev/null +++ b/docs/sk-rSK/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Trasovanie + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Informácia o susedoch + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/sk-rSK/user/firmware.md b/docs/sk-rSK/user/firmware.md new file mode 100644 index 000000000..367dc8548 --- /dev/null +++ b/docs/sk-rSK/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanál | Popis | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sk-rSK/user/map-and-waypoints.md b/docs/sk-rSK/user/map-and-waypoints.md new file mode 100644 index 000000000..a414b3796 --- /dev/null +++ b/docs/sk-rSK/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Zelená | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Modrá | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Popis | +| ---------- | ------------------------------------------------------- | +| Názov | Short identifier (max 30 characters) | +| Popis | Optional longer description | +| Icon | Visual marker emoji on the map | +| Zamknuté | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/sk-rSK/user/messages-and-channels.md b/docs/sk-rSK/user/messages-and-channels.md new file mode 100644 index 000000000..eda0696f3 --- /dev/null +++ b/docs/sk-rSK/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanále + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Popis | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Chyba | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Chyba | Meaning | What to Do | +| -------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Časový limit | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Žiadne rozhranie | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Žiaden kanál | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Nesprávna požiadavka | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/sk-rSK/user/mqtt.md b/docs/sk-rSK/user/mqtt.md new file mode 100644 index 000000000..6f42e389c --- /dev/null +++ b/docs/sk-rSK/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Popis | Predvolené | +| ------------------ | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Používateľské meno | Broker authentication | meshdev | +| Heslo | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Popis | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Popis | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/sk-rSK/user/node-metrics.md b/docs/sk-rSK/user/node-metrics.md new file mode 100644 index 000000000..76a0757c3 --- /dev/null +++ b/docs/sk-rSK/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Popis | +| --------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Napätie | Battery voltage reading | +| Využitie kanálu | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Doba prevádzky | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Teplota | BME280, BME680, SHT31 | +| Vlhkosť | BME280, BME680, SHT31 | +| Barometrický tlak | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Popis | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Dobrý | +| -10 to 0 dB | Primeraný | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Popis | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Prúd | Power draw in milliamps | +| Napájanie | Calculated wattage | + +## Trasovanie + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Log pozície + +Historical position data for nodes that share their location: + +- GPS coordinates +- Nadmorská výška +- Speed (if moving) +- Timestamp for each position report + +## Informácia o susedoch + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/sk-rSK/user/nodes.md b/docs/sk-rSK/user/nodes.md new file mode 100644 index 000000000..4ed2f0d17 --- /dev/null +++ b/docs/sk-rSK/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Rola | Popis | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Klient | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Stlmený Klient | Receives but doesn't retransmit | +| Skrytý Klient | Like Client Mute, plus hides from node list | +| Smerovač | Prioritizes message forwarding; stays awake to relay | +| Smerovač s Oneskorením | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Sledovač | Optimized for position reporting at regular intervals | +| Senzor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Sledovač | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Požiadať o pozíciu + - Mark as favorite + - Trasovanie + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Popis | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Popis | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| --------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Posledný príjem | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Vzdialenosť | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/sk-rSK/user/onboarding.md b/docs/sk-rSK/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/sk-rSK/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/sk-rSK/user/settings-module-admin.md b/docs/sk-rSK/user/settings-module-admin.md new file mode 100644 index 000000000..405b79d8e --- /dev/null +++ b/docs/sk-rSK/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Popis | +| ------------------ | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Používateľské meno | Authentication username | +| Heslo | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Popis | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Popis | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Popis | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Popis | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Popis | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Popis | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Správy | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Popis | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Popis | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Popis | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Popis | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Popis | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Popis | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administrácia + +### Administrácia na diaľku + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Reštartovať + +Remotely reboot a connected or administered node. + +### Debug okno + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sk-rSK/user/settings-radio-user.md b/docs/sk-rSK/user/settings-radio-user.md new file mode 100644 index 000000000..02380fba1 --- /dev/null +++ b/docs/sk-rSK/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - nastavenia + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Popis | +| ----------------- | ------------------------------------------------------------------------------------- | +| Dlhé Meno | Your display name (up to 39 characters) | +| Krátke Meno | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Konfigurácia Zariadenia + +| Setting | Popis | Predvolené | +| ------------------------------------------ | ----------------------------------------------------------------------- | ---------- | +| Rola | Node behavior (Client, Router, etc.) | Klient | +| Rebroadcast Mode | How the node retransmits messages | Všetky | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### Konfigurácia LoRa + +| Setting | Popis | Predvolené | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Región | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Rýchlosť | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Konfigurácia Displeju + +| Setting | Popis | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Popis | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Inteligentná poloha | Enable movement-based broadcasting | +| Fixná Pozícia | Use a manually set position | + +### Power Config + +| Setting | Popis | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Konfigurácia siete + +| Setting | Popis | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Konfigurácia Bluetooth + +| Setting | Popis | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Pevný PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Popis | +| --------------------- | -------------------------------------------------------------------------- | +| Verejný kľúč | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Súkromný kľúč | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/sk-rSK/user/signal-meter.md b/docs/sk-rSK/user/signal-meter.md new file mode 100644 index 000000000..3f1ed6289 --- /dev/null +++ b/docs/sk-rSK/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| --------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Dobrý | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Primeraný | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Zlý | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Žiadny | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/sk-rSK/user/tak.md b/docs/sk-rSK/user/tak.md new file mode 100644 index 000000000..6b68094ee --- /dev/null +++ b/docs/sk-rSK/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Popis | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Rola | Popis | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Popis | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Rola | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/sk-rSK/user/telemetry-and-sensors.md b/docs/sk-rSK/user/telemetry-and-sensors.md new file mode 100644 index 000000000..381c6fe7a --- /dev/null +++ b/docs/sk-rSK/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Popis | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Napätie | Battery voltage | 3.0–4.2V (LiPo) | +| Využitie kanálu | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Doba prevádzky | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Senzor | Teplota | Vlhkosť | Tlak | Notes | +| ------- | ------- | ------- | ---- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Senzor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Senzor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Popis | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Prúd | Power consumption (mA) | +| Napájanie | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/sk-rSK/user/translate.md b/docs/sk-rSK/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/sk-rSK/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/sk-rSK/user/units-and-locale.md b/docs/sk-rSK/user/units-and-locale.md new file mode 100644 index 000000000..18c71b36b --- /dev/null +++ b/docs/sk-rSK/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Teplota + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Nadmorská výška | +| -------------------------------- | -------------- | ---------------------- | --------------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Rýchlosť + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Vietor + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiácia | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/sl-rSI/index.md b/docs/sl-rSI/index.md new file mode 100644 index 000000000..0cb3c90e2 --- /dev/null +++ b/docs/sl-rSI/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Opis | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/sl-rSI/user/connections.md b/docs/sl-rSI/user/connections.md new file mode 100644 index 000000000..586122275 --- /dev/null +++ b/docs/sl-rSI/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Opis | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Prekinjeno | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/sl-rSI/user/desktop.md b/docs/sl-rSI/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/sl-rSI/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/sl-rSI/user/discovery.md b/docs/sl-rSI/user/discovery.md new file mode 100644 index 000000000..b55d35e86 --- /dev/null +++ b/docs/sl-rSI/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Pot + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/sl-rSI/user/firmware.md b/docs/sl-rSI/user/firmware.md new file mode 100644 index 000000000..28f6705bf --- /dev/null +++ b/docs/sl-rSI/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Opis | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sl-rSI/user/map-and-waypoints.md b/docs/sl-rSI/user/map-and-waypoints.md new file mode 100644 index 000000000..0568b93a5 --- /dev/null +++ b/docs/sl-rSI/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Opis | +| ---------- | ------------------------------------------------------- | +| Ime | Short identifier (max 30 characters) | +| Opis | Optional longer description | +| Icon | Visual marker emoji on the map | +| Zaklenjeno | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/sl-rSI/user/messages-and-channels.md b/docs/sl-rSI/user/messages-and-channels.md new file mode 100644 index 000000000..ae9993759 --- /dev/null +++ b/docs/sl-rSI/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Opis | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Napaka | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Napaka | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Časovna omejitev | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Brez vmesnika | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Brez kanala | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Slaba zahteva | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/sl-rSI/user/mqtt.md b/docs/sl-rSI/user/mqtt.md new file mode 100644 index 000000000..8108f2c93 --- /dev/null +++ b/docs/sl-rSI/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Opis | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Opis | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Opis | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/sl-rSI/user/node-metrics.md b/docs/sl-rSI/user/node-metrics.md new file mode 100644 index 000000000..570843847 --- /dev/null +++ b/docs/sl-rSI/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Opis | +| -------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Uporaba kanala | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatura | BME280, BME680, SHT31 | +| Vlaga | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Opis | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Dober | +| -10 to 0 dB | Precejšen | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Opis | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Pot + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Dnevnik lokacije + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/sl-rSI/user/nodes.md b/docs/sl-rSI/user/nodes.md new file mode 100644 index 000000000..d0c0a91f0 --- /dev/null +++ b/docs/sl-rSI/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Opis | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Zahtevaj položaj + - Mark as favorite + - Pot + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Opis | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Opis | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ---------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Nazadnje slišano | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Razdalja | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/sl-rSI/user/onboarding.md b/docs/sl-rSI/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/sl-rSI/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/sl-rSI/user/settings-module-admin.md b/docs/sl-rSI/user/settings-module-admin.md new file mode 100644 index 000000000..d8dbbee16 --- /dev/null +++ b/docs/sl-rSI/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Opis | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Opis | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Opis | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Opis | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Opis | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Opis | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Opis | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Messages | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Opis | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Opis | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Opis | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Opis | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Opis | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Opis | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administracija + +### Administracija na daljavo + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Ponovni zagon + +Remotely reboot a connected or administered node. + +### Plošča za odpravljanje napak + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sl-rSI/user/settings-radio-user.md b/docs/sl-rSI/user/settings-radio-user.md new file mode 100644 index 000000000..7a44ed2bb --- /dev/null +++ b/docs/sl-rSI/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Opis | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Opis | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Opis | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Regija | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Opis | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Opis | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Opis | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Opis | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Opis | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Opis | +| --------------------- | -------------------------------------------------------------------------- | +| Javni ključ | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Zasebni ključ | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/sl-rSI/user/signal-meter.md b/docs/sl-rSI/user/signal-meter.md new file mode 100644 index 000000000..e17238c69 --- /dev/null +++ b/docs/sl-rSI/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| --------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Dober | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Precejšen | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Slab | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Brez | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/sl-rSI/user/tak.md b/docs/sl-rSI/user/tak.md new file mode 100644 index 000000000..f7736efe0 --- /dev/null +++ b/docs/sl-rSI/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Opis | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Opis | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Opis | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/sl-rSI/user/telemetry-and-sensors.md b/docs/sl-rSI/user/telemetry-and-sensors.md new file mode 100644 index 000000000..1c21e4e5c --- /dev/null +++ b/docs/sl-rSI/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Opis | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Uporaba kanala | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatura | Vlaga | Pressure | Notes | +| ------- | ----------- | ----- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Opis | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/sl-rSI/user/translate.md b/docs/sl-rSI/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/sl-rSI/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/sl-rSI/user/units-and-locale.md b/docs/sl-rSI/user/units-and-locale.md new file mode 100644 index 000000000..d4efd4ad1 --- /dev/null +++ b/docs/sl-rSI/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatura + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/sq-rAL/index.md b/docs/sq-rAL/index.md new file mode 100644 index 000000000..708ab106d --- /dev/null +++ b/docs/sq-rAL/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Përshkrimi | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/sq-rAL/user/connections.md b/docs/sq-rAL/user/connections.md new file mode 100644 index 000000000..d79d5c7ff --- /dev/null +++ b/docs/sq-rAL/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Përshkrimi | +| ---- | -------------- | ----------------------------- | +| 🟢 | Connected | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | I shkëputur | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/sq-rAL/user/desktop.md b/docs/sq-rAL/user/desktop.md new file mode 100644 index 000000000..a688679eb --- /dev/null +++ b/docs/sq-rAL/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Map | ✓ | ✓ | Full parity | +| Settings | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/sq-rAL/user/discovery.md b/docs/sq-rAL/user/discovery.md new file mode 100644 index 000000000..fe696299b --- /dev/null +++ b/docs/sq-rAL/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/sq-rAL/user/firmware.md b/docs/sq-rAL/user/firmware.md new file mode 100644 index 000000000..e67f69e58 --- /dev/null +++ b/docs/sq-rAL/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Përshkrimi | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sq-rAL/user/map-and-waypoints.md b/docs/sq-rAL/user/map-and-waypoints.md new file mode 100644 index 000000000..366eafc58 --- /dev/null +++ b/docs/sq-rAL/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Përshkrimi | +| ---------- | ------------------------------------------------------- | +| Emri | Short identifier (max 30 characters) | +| Përshkrimi | Optional longer description | +| Icon | Visual marker emoji on the map | +| I bllokuar | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/sq-rAL/user/messages-and-channels.md b/docs/sq-rAL/user/messages-and-channels.md new file mode 100644 index 000000000..0788a8064 --- /dev/null +++ b/docs/sq-rAL/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Channels + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Përshkrimi | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Gabim | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Gabim | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Koha e skaduar | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Nuk ka ndërfaqe | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Nuk ka kanal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Kërkesë e gabuar | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/sq-rAL/user/mqtt.md b/docs/sq-rAL/user/mqtt.md new file mode 100644 index 000000000..f662e669a --- /dev/null +++ b/docs/sq-rAL/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Përshkrimi | Default | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Username | Broker authentication | meshdev | +| Password | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Përshkrimi | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Përshkrimi | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/sq-rAL/user/node-metrics.md b/docs/sq-rAL/user/node-metrics.md new file mode 100644 index 000000000..1bcffcfce --- /dev/null +++ b/docs/sq-rAL/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Përshkrimi | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltage | Battery voltage reading | +| Përdorimi i kanalit | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Uptime | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatura | BME280, BME680, SHT31 | +| Lagështia | BME280, BME680, SHT31 | +| Barometric Pressure | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Përshkrimi | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Mirë | +| -10 to 0 dB | Mesatar | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Përshkrimi | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Current | Power draw in milliamps | +| Power | Calculated wattage | + +## Traceroute + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Regjistri i Pozitës + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitude +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/sq-rAL/user/nodes.md b/docs/sq-rAL/user/nodes.md new file mode 100644 index 000000000..433f73950 --- /dev/null +++ b/docs/sq-rAL/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodes +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodes + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Role | Përshkrimi | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Kërkoni pozicionin + - Mark as favorite + - Traceroute + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtrimi | Përshkrimi | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Përshkrimi | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| I fundit që u dëgjua | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Distanca | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/sq-rAL/user/onboarding.md b/docs/sq-rAL/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/sq-rAL/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/sq-rAL/user/settings-module-admin.md b/docs/sq-rAL/user/settings-module-admin.md new file mode 100644 index 000000000..5a370608c --- /dev/null +++ b/docs/sq-rAL/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Përshkrimi | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| Server | MQTT broker address | +| Username | Authentication username | +| Password | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Përshkrimi | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| Echo | Echo received serial data back | +| Mode | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Përshkrimi | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Përshkrimi | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Përshkrimi | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Përshkrimi | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Përshkrimi | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| 訊息 | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Përshkrimi | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Përshkrimi | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Përshkrimi | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Përshkrimi | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Përshkrimi | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Përshkrimi | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administratë + +### Administratë e Largët + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Rindiz + +Remotely reboot a connected or administered node. + +### Paneli i debug-ut + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sq-rAL/user/settings-radio-user.md b/docs/sq-rAL/user/settings-radio-user.md new file mode 100644 index 000000000..c1921577f --- /dev/null +++ b/docs/sq-rAL/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - settings + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Përshkrimi | +| ----------------- | ------------------------------------------------------------------------------------- | +| Long Name | Your display name (up to 39 characters) | +| Short Name | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Device Config + +| Setting | Përshkrimi | Default | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Role | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | All | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Përshkrimi | Default | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Rajon | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Përshkrimi | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Type | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Përshkrimi | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Power Config + +| Setting | Përshkrimi | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Përshkrimi | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Config + +| Setting | Përshkrimi | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Përshkrimi | +| --------------------- | -------------------------------------------------------------------------- | +| Public Key | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Private Key | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/sq-rAL/user/signal-meter.md b/docs/sq-rAL/user/signal-meter.md new file mode 100644 index 000000000..9afd86896 --- /dev/null +++ b/docs/sq-rAL/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Mirë | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Mesatar | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| I Keq | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Asnjë | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/sq-rAL/user/tak.md b/docs/sq-rAL/user/tak.md new file mode 100644 index 000000000..a6a2fe63e --- /dev/null +++ b/docs/sq-rAL/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Përshkrimi | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| Mode | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Role | Përshkrimi | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Përshkrimi | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Role | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/sq-rAL/user/telemetry-and-sensors.md b/docs/sq-rAL/user/telemetry-and-sensors.md new file mode 100644 index 000000000..e016adf76 --- /dev/null +++ b/docs/sq-rAL/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Përshkrimi | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltage | Battery voltage | 3.0–4.2V (LiPo) | +| Përdorimi i kanalit | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Uptime | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatura | Lagështia | Pressure | Notes | +| ------- | ----------- | --------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Përshkrimi | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Current | Power consumption (mA) | +| Power | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/sq-rAL/user/translate.md b/docs/sq-rAL/user/translate.md new file mode 100644 index 000000000..b2ed79a34 --- /dev/null +++ b/docs/sq-rAL/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/sq-rAL/user/units-and-locale.md b/docs/sq-rAL/user/units-and-locale.md new file mode 100644 index 000000000..d4efd4ad1 --- /dev/null +++ b/docs/sq-rAL/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatura + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitude | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/sr-rLatn/index.md b/docs/sr-rLatn/index.md new file mode 100644 index 000000000..1e717192c --- /dev/null +++ b/docs/sr-rLatn/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Опис | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/sr-rLatn/user/connections.md b/docs/sr-rLatn/user/connections.md new file mode 100644 index 000000000..02f4465c8 --- /dev/null +++ b/docs/sr-rLatn/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Иконица | State | Опис | +| ------- | -------------- | ----------------------------- | +| 🟢 | Блутут повезан | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Raskačeno | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/sr-rLatn/user/desktop.md b/docs/sr-rLatn/user/desktop.md new file mode 100644 index 000000000..a5d01e7e3 --- /dev/null +++ b/docs/sr-rLatn/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Белешке | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Мапа | ✓ | ✓ | Full parity | +| Подешавања | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Отвори подешавања | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/sr-rLatn/user/discovery.md b/docs/sr-rLatn/user/discovery.md new file mode 100644 index 000000000..55092187e --- /dev/null +++ b/docs/sr-rLatn/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Праћење руте + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/sr-rLatn/user/firmware.md b/docs/sr-rLatn/user/firmware.md new file mode 100644 index 000000000..adcf73bf4 --- /dev/null +++ b/docs/sr-rLatn/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Ажурирања фирмвера +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Ажурирања фирмвера + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Опис | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sr-rLatn/user/map-and-waypoints.md b/docs/sr-rLatn/user/map-and-waypoints.md new file mode 100644 index 000000000..a14f2e439 --- /dev/null +++ b/docs/sr-rLatn/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Боја | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Опис | +| ---------- | ------------------------------------------------------- | +| Назив | Short identifier (max 30 characters) | +| Опис | Optional longer description | +| Иконица | Visual marker emoji on the map | +| Закључано | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/sr-rLatn/user/messages-and-channels.md b/docs/sr-rLatn/user/messages-and-channels.md new file mode 100644 index 000000000..af620a044 --- /dev/null +++ b/docs/sr-rLatn/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Канали + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Иконица | Security Level | Опис | +| ------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Директне поруке + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Иконица | Meaning | +| --------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Грешка | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Грешка | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Нема руте | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Isteklo vreme | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Nema interfejsa | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Nema kanala | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Нема одговора | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Loš zahtev | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/sr-rLatn/user/mqtt.md b/docs/sr-rLatn/user/mqtt.md new file mode 100644 index 000000000..27340a59d --- /dev/null +++ b/docs/sr-rLatn/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Опис | Подразумевано | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Адреса сервера | MQTT broker hostname | mqtt.meshtastic.org | +| Корисничко име | Broker authentication | meshdev | +| Лозинка | Broker authentication | large4cats | +| Корен тема | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Омогућено | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Онемогућено | +| TLS | Secure connection to broker | Онемогућено | +| Map Reporting | Report position to public map | Онемогућено | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Опис | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Опис | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/sr-rLatn/user/node-metrics.md b/docs/sr-rLatn/user/node-metrics.md new file mode 100644 index 000000000..f26fc2a24 --- /dev/null +++ b/docs/sr-rLatn/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Метрика уређаја + +Basic operating information reported by each node: + +| Метрика | Опис | +| -------------------- | ----------------------------------- | +| Ниво батерије | Current battery percentage | +| Напон | Battery voltage reading | +| Искоришћеност канала | Percentage of airtime consumed | +| Време емитовања | Transmission time used by this node | +| Време рада | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Метрике сензора + +Environmental sensor data (requires compatible hardware): + +| Метрика | Sensor Examples | +| ------------------------------------ | --------------------- | +| Температура | BME280, BME680, SHT31 | +| Влажност | BME280, BME680, SHT31 | +| Барометарски притисак | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Метрика | Опис | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ----------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Dobro | +| -10 to 0 dB | Prihvatljiv | +| < -10 dB | Poor | + +## Мерни подаци о снази + +Power management telemetry (requires INA sensor or compatible hardware): + +| Метрика | Опис | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Струја | Power draw in milliamps | +| Снага | Calculated wattage | + +## Праћење руте + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Dnevnik lokacija + +Historical position data for nodes that share their location: + +- GPS coordinates +- Висина +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/sr-rLatn/user/nodes.md b/docs/sr-rLatn/user/nodes.md new file mode 100644 index 000000000..f08ee1160 --- /dev/null +++ b/docs/sr-rLatn/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Чворови +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Чворови + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Улога | Опис | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Клијент | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Клијент мутиран | Receives but doesn't retransmit | +| Скривени клијент | Like Client Mute, plus hides from node list | +| Рутер | Prioritizes message forwarding; stays awake to relay | +| Рутер са кашњењем | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Трекер | Optimized for position reporting at regular intervals | +| Сензор | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| ТАК Трекер | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Иконица | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Захтевај позицију + - Mark as favorite + - Праћење руте + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Опис | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Опис | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Poslednji put viđeno | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Udaljenost | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/sr-rLatn/user/onboarding.md b/docs/sr-rLatn/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/sr-rLatn/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/sr-rLatn/user/settings-module-admin.md b/docs/sr-rLatn/user/settings-module-admin.md new file mode 100644 index 000000000..8bb0227b2 --- /dev/null +++ b/docs/sr-rLatn/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Конфигурација модула + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Опис | +| --------------- | ------------------------------------------------------------------------ | +| Омогућено | Toggle MQTT bridge | +| Сервер | MQTT broker address | +| Корисничко име | Authentication username | +| Лозинка | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Корен тема | Base MQTT topic path | +| Извештај мапе | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Опис | +| ---------- | ------------------------------- | +| Омогућено | Activate serial communication | +| Ехо | Echo received serial data back | +| Мод | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Опис | +| -------------------------------- | --------------------------- | +| Омогућено | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Активан | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Опис | +| ------------------------------------------ | -------------------------- | +| Омогућено | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Опис | +| -------------------------------------- | --------------------------------- | +| Омогућено | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Опис | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Опис | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Поруке | Newline-separated list of messages | +| Пошаљи звоно | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Опис | +| --------------- | -------------------------------- | +| Омогућено | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Опис | +| -------------------- | --------------------------------------------------------------- | +| Омогућено | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Опис | +| -------------------------------------- | ------------------------------------ | +| Омогућено | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Опис | +| ------------------ | ---------------------------------------------------------- | +| Омогућено | Activate LED control | +| LED статус | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Опис | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Омогућено | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Пошаљи звоно | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Опис | +| -------------------------------------- | -------------------------- | +| Омогућено | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administracija + +### Udaljena administracija + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Ресетовање на фабричка подешавања + +Resets all settings to factory defaults. **This cannot be undone.** + +### Поново покрени + +Remotely reboot a connected or administered node. + +### Panel za otklanjanje grešaka + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sr-rLatn/user/settings-radio-user.md b/docs/sr-rLatn/user/settings-radio-user.md new file mode 100644 index 000000000..54b8d1403 --- /dev/null +++ b/docs/sr-rLatn/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - подешавања + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Опис | +| -------------------- | ------------------------------------------------------------------------------------- | +| Дуго име | Your display name (up to 39 characters) | +| Кратко име | 4-character abbreviated name | +| Лиценцирани оператор | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Конфигурација радио уређаја + +### Подешавања уређаја + +| Setting | Опис | Подразумевано | +| ------------------------------------------ | ----------------------------------------------------------------------- | ------------- | +| Улога | Node behavior (Client, Router, etc.) | Клијент | +| Режим реемитовања | How the node retransmits messages | Сви | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Онемогућено | + +### LoRA подешавања + +| Setting | Опис | Подразумевано | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Регион | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Брзина | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Подешавања приказа + +| Setting | Опис | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Јединице приказа | Metric or Imperial | +| Тип OLED-а | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Подешавања позиције + +| Setting | Опис | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Паметно позиционирање | Enable movement-based broadcasting | +| Фиксна локација | Use a manually set position | + +### Подешавања напајња + +| Setting | Опис | +| --------------------------------------- | --------------------------------------- | +| Уштеда енергије | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Конфигурација мреже + +| Setting | Опис | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Блутут подешавања + +| Setting | Опис | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Мод упаривања | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Сигурносна подешавања + +| Setting | Опис | +| --------------------- | -------------------------------------------------------------------------- | +| Javni ključ | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Privatni ključ | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/sr-rLatn/user/signal-meter.md b/docs/sr-rLatn/user/signal-meter.md new file mode 100644 index 000000000..472931a08 --- /dev/null +++ b/docs/sr-rLatn/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Ниво | Bars | Criteria | Meaning | +| ----------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Dobro | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Prihvatljiv | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Loš | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Bez | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/sr-rLatn/user/tak.md b/docs/sr-rLatn/user/tak.md new file mode 100644 index 000000000..5544856ef --- /dev/null +++ b/docs/sr-rLatn/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Опис | +| --------- | -------------------------- | +| Омогућено | Activate TAK interop | +| Мод | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Улога | Опис | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Опис | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Улога | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/sr-rLatn/user/telemetry-and-sensors.md b/docs/sr-rLatn/user/telemetry-and-sensors.md new file mode 100644 index 000000000..47a98a875 --- /dev/null +++ b/docs/sr-rLatn/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - окружење + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Метрика | Опис | Typical Range | +| -------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Ниво батерије | Charge percentage | 0–100% | +| Напон | Battery voltage | 3.0–4.2V (LiPo) | +| Искоришћеност канала | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Време рада | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Сензор | Температура | Влажност | Pressure | Белешке | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Сензор | Метрика | Белешке | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Сензор | Метрика | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Мерни подаци о снази + +Nodes with INA-series power sensors can report: + +| Метрика | Опис | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Струја | Power consumption (mA) | +| Снага | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/sr-rLatn/user/translate.md b/docs/sr-rLatn/user/translate.md new file mode 100644 index 000000000..7914d6092 --- /dev/null +++ b/docs/sr-rLatn/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Белешке | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/sr-rLatn/user/units-and-locale.md b/docs/sr-rLatn/user/units-and-locale.md new file mode 100644 index 000000000..add5204e3 --- /dev/null +++ b/docs/sr-rLatn/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Температура + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Висина | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Метрика | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Брзина + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Метрика | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Метрика | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Метрика | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/srp/index.md b/docs/srp/index.md new file mode 100644 index 000000000..1e717192c --- /dev/null +++ b/docs/srp/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Опис | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/srp/user/connections.md b/docs/srp/user/connections.md new file mode 100644 index 000000000..80a1ac470 --- /dev/null +++ b/docs/srp/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Иконица | State | Опис | +| ------- | -------------- | ----------------------------- | +| 🟢 | Блутут повезан | Active radio link established | +| 🟡 | Connecting | Handshake in progress | +| 🔴 | Раскачено | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/srp/user/desktop.md b/docs/srp/user/desktop.md new file mode 100644 index 000000000..a5d01e7e3 --- /dev/null +++ b/docs/srp/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Белешке | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Мапа | ✓ | ✓ | Full parity | +| Подешавања | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Отвори подешавања | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/srp/user/discovery.md b/docs/srp/user/discovery.md new file mode 100644 index 000000000..55092187e --- /dev/null +++ b/docs/srp/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Праћење руте + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Neighbor Info + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/srp/user/firmware.md b/docs/srp/user/firmware.md new file mode 100644 index 000000000..c7c23f47e --- /dev/null +++ b/docs/srp/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Ажурирања фирмвера +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Ажурирања фирмвера + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Канал | Опис | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/srp/user/map-and-waypoints.md b/docs/srp/user/map-and-waypoints.md new file mode 100644 index 000000000..f3986954d --- /dev/null +++ b/docs/srp/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Боја | Meaning | +| ------ | ---------------------------------------------- | +| Green | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Опис | +| ---------- | ------------------------------------------------------- | +| Име | Short identifier (max 30 characters) | +| Опис | Optional longer description | +| Иконица | Visual marker emoji on the map | +| Закључан | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/srp/user/messages-and-channels.md b/docs/srp/user/messages-and-channels.md new file mode 100644 index 000000000..3af5645f5 --- /dev/null +++ b/docs/srp/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Канали + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Иконица | Security Level | Опис | +| ------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Директне поруке + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Иконица | Meaning | +| --------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Грешка | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Грешка | Meaning | What to Do | +| -------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Нема руте | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Временско ограничење | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Нема интерфејса | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Нема канала | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Нема одговора | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Лош захтев | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/srp/user/mqtt.md b/docs/srp/user/mqtt.md new file mode 100644 index 000000000..27340a59d --- /dev/null +++ b/docs/srp/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Опис | Подразумевано | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Адреса сервера | MQTT broker hostname | mqtt.meshtastic.org | +| Корисничко име | Broker authentication | meshdev | +| Лозинка | Broker authentication | large4cats | +| Корен тема | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Омогућено | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Онемогућено | +| TLS | Secure connection to broker | Онемогућено | +| Map Reporting | Report position to public map | Онемогућено | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Опис | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Опис | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/srp/user/node-metrics.md b/docs/srp/user/node-metrics.md new file mode 100644 index 000000000..e1e76387e --- /dev/null +++ b/docs/srp/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Метрика уређаја + +Basic operating information reported by each node: + +| Метрика | Опис | +| -------------------- | ----------------------------------- | +| Ниво батерије | Current battery percentage | +| Напон | Battery voltage reading | +| Искоришћеност канала | Percentage of airtime consumed | +| Време емитовања | Transmission time used by this node | +| Време рада | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Метрике сензора + +Environmental sensor data (requires compatible hardware): + +| Метрика | Sensor Examples | +| ------------------------------------ | --------------------- | +| Температура | BME280, BME680, SHT31 | +| Влажност | BME280, BME680, SHT31 | +| Барометарски притисак | BME280, BMP280 | +| Gas Resistance | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Метрика | Опис | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ---------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Добро | +| -10 to 0 dB | Прихватљив | +| < -10 dB | Poor | + +## Мерни подаци о снази + +Power management telemetry (requires INA sensor or compatible hardware): + +| Метрика | Опис | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Струја | Power draw in milliamps | +| Снага | Calculated wattage | + +## Праћење руте + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Логови позиција + +Historical position data for nodes that share their location: + +- GPS coordinates +- Висина +- Speed (if moving) +- Timestamp for each position report + +## Neighbor Info + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/srp/user/nodes.md b/docs/srp/user/nodes.md new file mode 100644 index 000000000..00b16b535 --- /dev/null +++ b/docs/srp/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Чворови +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Чворови + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Улога | Опис | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Клијент | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Клијент мутиран | Receives but doesn't retransmit | +| Скривени клијент | Like Client Mute, plus hides from node list | +| Рутер | Prioritizes message forwarding; stays awake to relay | +| Рутер са кашњењем | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Трекер | Optimized for position reporting at regular intervals | +| Сензор | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| ТАК Трекер | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Иконица | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Захтевај позицију + - Mark as favorite + - Праћење руте + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Филтер | Опис | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Опис | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| ------------------ | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Последње откривање | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Раздаљина | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/srp/user/onboarding.md b/docs/srp/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/srp/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/srp/user/settings-module-admin.md b/docs/srp/user/settings-module-admin.md new file mode 100644 index 000000000..b2cb5c079 --- /dev/null +++ b/docs/srp/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Конфигурација модула + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Опис | +| --------------- | ------------------------------------------------------------------------ | +| Омогућено | Toggle MQTT bridge | +| Сервер | MQTT broker address | +| Корисничко име | Authentication username | +| Лозинка | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Корен тема | Base MQTT topic path | +| Извештај мапе | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Опис | +| ---------- | ------------------------------- | +| Омогућено | Activate serial communication | +| Ехо | Echo received serial data back | +| Мод | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Опис | +| -------------------------------- | --------------------------- | +| Омогућено | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Активан | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Опис | +| ------------------------------------------ | -------------------------- | +| Омогућено | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Опис | +| -------------------------------------- | --------------------------------- | +| Омогућено | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Опис | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Опис | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Поруке | Newline-separated list of messages | +| Пошаљи звоно | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Опис | +| --------------- | -------------------------------- | +| Омогућено | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Опис | +| -------------------- | --------------------------------------------------------------- | +| Омогућено | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Опис | +| -------------------------------------- | ------------------------------------ | +| Омогућено | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Опис | +| ------------------ | ---------------------------------------------------------- | +| Омогућено | Activate LED control | +| LED статус | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Опис | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Омогућено | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Пошаљи звоно | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Опис | +| -------------------------------------- | -------------------------- | +| Омогућено | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Администрација + +### Удаљена администрација + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Ресетовање на фабричка подешавања + +Resets all settings to factory defaults. **This cannot be undone.** + +### Поновно покретање + +Remotely reboot a connected or administered node. + +### Панел за отклањање грешака + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/srp/user/settings-radio-user.md b/docs/srp/user/settings-radio-user.md new file mode 100644 index 000000000..51d4a4b85 --- /dev/null +++ b/docs/srp/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - подешавања + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Опис | +| -------------------- | ------------------------------------------------------------------------------------- | +| Дуго име | Your display name (up to 39 characters) | +| Кратко име | 4-character abbreviated name | +| Лиценцирани оператор | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Конфигурација радио уређаја + +### Подешавања уређаја + +| Setting | Опис | Подразумевано | +| ------------------------------------------ | ----------------------------------------------------------------------- | ------------- | +| Улога | Node behavior (Client, Router, etc.) | Клијент | +| Режим реемитовања | How the node retransmits messages | Сви | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Онемогућено | + +### LoRA подешавања + +| Setting | Опис | Подразумевано | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Регион | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Брзина | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Подешавања приказа + +| Setting | Опис | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Јединице приказа | Metric or Imperial | +| Тип OLED-а | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Подешавања позиције + +| Setting | Опис | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Паметно позиционирање | Enable movement-based broadcasting | +| Фиксна локација | Use a manually set position | + +### Подешавања напајња + +| Setting | Опис | +| --------------------------------------- | --------------------------------------- | +| Уштеда енергије | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Конфигурација мреже + +| Setting | Опис | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP Server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Блутут подешавања + +| Setting | Опис | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Мод упаривања | Fixed PIN, Random PIN, or No PIN | +| Fixed PIN | PIN code for pairing (default: 123456) | + +### Сигурносна подешавања + +| Setting | Опис | +| --------------------- | -------------------------------------------------------------------------- | +| Јавни кључ | Your node's public key (read-only) | +| Admin Key | Key for remote administration | +| Приватни кључ | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Managed Mode | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/srp/user/signal-meter.md b/docs/srp/user/signal-meter.md new file mode 100644 index 000000000..2204b907a --- /dev/null +++ b/docs/srp/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Ниво | Bars | Criteria | Meaning | +| ---------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Добро | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Прихватљив | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Лош | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Ништа | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/srp/user/tak.md b/docs/srp/user/tak.md new file mode 100644 index 000000000..5544856ef --- /dev/null +++ b/docs/srp/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Опис | +| --------- | -------------------------- | +| Омогућено | Activate TAK interop | +| Мод | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Улога | Опис | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Опис | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Улога | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/srp/user/telemetry-and-sensors.md b/docs/srp/user/telemetry-and-sensors.md new file mode 100644 index 000000000..47a98a875 --- /dev/null +++ b/docs/srp/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - окружење + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Метрика | Опис | Typical Range | +| -------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Ниво батерије | Charge percentage | 0–100% | +| Напон | Battery voltage | 3.0–4.2V (LiPo) | +| Искоришћеност канала | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Време рада | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Сензор | Температура | Влажност | Pressure | Белешке | +| ------- | ----------- | -------- | -------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Сензор | Метрика | Белешке | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Сензор | Метрика | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Мерни подаци о снази + +Nodes with INA-series power sensors can report: + +| Метрика | Опис | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Струја | Power consumption (mA) | +| Снага | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/srp/user/translate.md b/docs/srp/user/translate.md new file mode 100644 index 000000000..7914d6092 --- /dev/null +++ b/docs/srp/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Белешке | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/srp/user/units-and-locale.md b/docs/srp/user/units-and-locale.md new file mode 100644 index 000000000..add5204e3 --- /dev/null +++ b/docs/srp/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Температура + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Висина | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Метрика | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Брзина + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Метрика | 12 km/h | +| Imperial (US) | 7 mph | + +## Wind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Метрика | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Метрика | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radiation | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/sv-rSE/index.md b/docs/sv-rSE/index.md new file mode 100644 index 000000000..1cb34b05a --- /dev/null +++ b/docs/sv-rSE/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Beskrivning | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/sv-rSE/user/connections.md b/docs/sv-rSE/user/connections.md new file mode 100644 index 000000000..e445825a0 --- /dev/null +++ b/docs/sv-rSE/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Beskrivning | +| ---- | -------------- | ----------------------------- | +| 🟢 | Ansluten | Active radio link established | +| 🟡 | Ansluter | Handshake in progress | +| 🔴 | Frånkopplad | No active connection | +| ⚪ | Not configured | Ingen enhet vald | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Konfiguration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/sv-rSE/user/desktop.md b/docs/sv-rSE/user/desktop.md new file mode 100644 index 000000000..f43f5f958 --- /dev/null +++ b/docs/sv-rSE/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Anteckningar | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Karta | ✓ | ✓ | Full parity | +| Inställningar | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/sv-rSE/user/discovery.md b/docs/sv-rSE/user/discovery.md new file mode 100644 index 000000000..dbf98efb8 --- /dev/null +++ b/docs/sv-rSE/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Upptäckt +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Upptäckt + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Traceroute (spåra rutt) + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Granninformation + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/sv-rSE/user/firmware.md b/docs/sv-rSE/user/firmware.md new file mode 100644 index 000000000..333bcd162 --- /dev/null +++ b/docs/sv-rSE/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Beskrivning | +| -------------- | ------------------------------------------- | +| Stabil version | Recommended for most users; tested releases | +| Alfa | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Felsökning + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sv-rSE/user/map-and-waypoints.md b/docs/sv-rSE/user/map-and-waypoints.md new file mode 100644 index 000000000..b02961c87 --- /dev/null +++ b/docs/sv-rSE/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ----- | ---------------------------------------------- | +| Grönt | Online (heard recently) | +| Gul | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blått | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Beskrivning | +| ----------- | ------------------------------------------------------- | +| Namn | Short identifier (max 30 characters) | +| Beskrivning | Optional longer description | +| Icon | Visual marker emoji on the map | +| Låst | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/sv-rSE/user/messages-and-channels.md b/docs/sv-rSE/user/messages-and-channels.md new file mode 100644 index 000000000..ba48008d1 --- /dev/null +++ b/docs/sv-rSE/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanaler + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Kanalsäkerhet + +Channels support multiple encryption levels: + +| Icon | Security Level | Beskrivning | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Levererad | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Fel | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Fel | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Inget gränssnitt | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Ingen kanal | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Inget svar | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Misslyckad | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/sv-rSE/user/mqtt.md b/docs/sv-rSE/user/mqtt.md new file mode 100644 index 000000000..bdeadc5bf --- /dev/null +++ b/docs/sv-rSE/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Konfiguration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Beskrivning | Förvald | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Användarnamn | Broker authentication | meshdev | +| Lösenord | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Kryptering | Encrypt MQTT payload | Aktiverad | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Beskrivning | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Beskrivning | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Felsökning + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/sv-rSE/user/node-metrics.md b/docs/sv-rSE/user/node-metrics.md new file mode 100644 index 000000000..1875f997c --- /dev/null +++ b/docs/sv-rSE/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Enhetens mätvärden + +Basic operating information reported by each node: + +| Metric | Beskrivning | +| ---------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Spänning | Battery voltage reading | +| Kanalutnyttjande | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Upptid | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Miljövärden + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Temperatur | BME280, BME680, SHT31 | +| Luftfuktighet | BME280, BME680, SHT31 | +| Lufttryck | BME280, BMP280 | +| Gasmotstånd | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Beskrivning | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Bra | +| -10 to 0 dB | Ok | +| < -10 dB | Poor | + +## Strömdata + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Beskrivning | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Ström | Power draw in milliamps | +| Ström | Calculated wattage | + +## Traceroute (spåra rutt) + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Loggbok + +Historical position data for nodes that share their location: + +- GPS coordinates +- Altitud +- Speed (if moving) +- Timestamp for each position report + +## Granninformation + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/sv-rSE/user/nodes.md b/docs/sv-rSE/user/nodes.md new file mode 100644 index 000000000..d248541df --- /dev/null +++ b/docs/sv-rSE/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Noder +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Noder + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Roll | Beskrivning | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Visa på karta + - Begär position + - Mark as favorite + - Traceroute (spåra rutt) + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filter | Beskrivning | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Beskrivning | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Batterinivå | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Senast hörd | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Avstånd | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/sv-rSE/user/onboarding.md b/docs/sv-rSE/user/onboarding.md new file mode 100644 index 000000000..b73399ed9 --- /dev/null +++ b/docs/sv-rSE/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Kom igång +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Kom igång + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/sv-rSE/user/settings-module-admin.md b/docs/sv-rSE/user/settings-module-admin.md new file mode 100644 index 000000000..61810ece3 --- /dev/null +++ b/docs/sv-rSE/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Beskrivning | +| --------------- | ------------------------------------------------------------------------ | +| Aktiverad | Toggle MQTT bridge | +| Server | MQTT broker address | +| Användarnamn | Authentication username | +| Lösenord | Authentication password | +| Kryptering | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Beskrivning | +| ---------- | ------------------------------- | +| Aktiverad | Activate serial communication | +| Eko | Echo received serial data back | +| Typ | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Hastighet | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Beskrivning | +| -------------------------------- | --------------------------- | +| Aktiverad | Activate notifications | +| Meddelande-utgång | Notify on incoming messages | +| Meddelande-summer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Klock-tecken-utgång | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Aktiv | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Beskrivning | +| ------------------------------------------ | -------------------------- | +| Aktiverad | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Post | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Beskrivning | +| -------------------------------------- | --------------------------------- | +| Aktiverad | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Beskrivning | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Aktivera luftkvalitet | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Beskrivning | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Meddelanden | Newline-separated list of messages | +| Skicka klocka | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Beskrivning | +| --------------- | -------------------------------- | +| Aktiverad | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Beskrivning | +| -------------------- | --------------------------------------------------------------- | +| Aktiverad | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Beskrivning | +| -------------------------------------- | ------------------------------------ | +| Aktiverad | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Beskrivning | +| ------------------ | ---------------------------------------------------------- | +| Aktiverad | Activate LED control | +| LED-läge | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Beskrivning | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Aktiverad | Activate detection sensor | +| Stift att övervaka | GPIO pin connected to sensor | +| Logiknivå för detektion | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Skicka klocka | Include bell character in alerts | +| Visningsnamn | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Beskrivning | +| -------------------------------------- | -------------------------- | +| Aktiverad | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Administration + +### Fjärradministration + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Rensa noddatabas + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Starta om + +Remotely reboot a connected or administered node. + +### Felsökningspanel + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/sv-rSE/user/settings-radio-user.md b/docs/sv-rSE/user/settings-radio-user.md new file mode 100644 index 000000000..10e2c55fa --- /dev/null +++ b/docs/sv-rSE/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - inställningar + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## Användarinställningar + +### User Profile + +| Setting | Beskrivning | +| ----------------- | ------------------------------------------------------------------------------------- | +| Långt namn | Your display name (up to 39 characters) | +| Kort namn | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Enhetskonfiguration + +| Setting | Beskrivning | Förvald | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| Roll | Node behavior (Client, Router, etc.) | Client | +| Återutsändningsläge | How the node retransmits messages | Alla | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Config + +| Setting | Beskrivning | Förvald | +| ---------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Region | Regulatory region for frequency bands | Unset (must configure) | +| Modem-förinställningar | Speed/range tradeoff | LongFast | +| Hoppgräns | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frekvensförskjutning | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Hastighet | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Display Config + +| Setting | Beskrivning | +| --------------------- | ------------------------------------------------------------------------------------ | +| Tidsgräns för display | Time before display sleeps | +| Enheter | Metric or Imperial | +| OLED-typ | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Beskrivning | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| Intervall för GPS-uppdatering | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart position | Enable movement-based broadcasting | +| Fast plats | Use a manually set position | + +### Ströminställningar + +| Setting | Beskrivning | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Network Config + +| Setting | Beskrivning | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Nätverkslösenord | +| NTP-server | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth-inställningar + +| Setting | Beskrivning | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Fast PIN | PIN code for pairing (default: 123456) | + +### Security Config + +| Setting | Beskrivning | +| --------------------- | -------------------------------------------------------------------------- | +| Publik nyckel | Your node's public key (read-only) | +| Admin-nyckel | Key for remote administration | +| Privat nyckel | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Hanterat läge | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/sv-rSE/user/signal-meter.md b/docs/sv-rSE/user/signal-meter.md new file mode 100644 index 000000000..ecee00499 --- /dev/null +++ b/docs/sv-rSE/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Bra | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Ok | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Dålig | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Ingen | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/sv-rSE/user/tak.md b/docs/sv-rSE/user/tak.md new file mode 100644 index 000000000..7f4a4be7b --- /dev/null +++ b/docs/sv-rSE/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Konfiguration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Beskrivning | +| --------- | -------------------------- | +| Aktiverad | Activate TAK interop | +| Typ | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Roll | Beskrivning | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Beskrivning | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Roll | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Felsökning + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/sv-rSE/user/telemetry-and-sensors.md b/docs/sv-rSE/user/telemetry-and-sensors.md new file mode 100644 index 000000000..8dab15dcb --- /dev/null +++ b/docs/sv-rSE/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Beskrivning | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Spänning | Battery voltage | 3.0–4.2V (LiPo) | +| Kanalutnyttjande | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Upptid | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Temperatur | Luftfuktighet | Tryck | Anteckningar | +| ------- | ---------- | ------------- | ----- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Anteckningar | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Strömdata + +Nodes with INA-series power sensors can report: + +| Metric | Beskrivning | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Ström | Power consumption (mA) | +| Ström | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Felsökning + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/sv-rSE/user/translate.md b/docs/sv-rSE/user/translate.md new file mode 100644 index 000000000..14a037743 --- /dev/null +++ b/docs/sv-rSE/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Anteckningar | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/sv-rSE/user/units-and-locale.md b/docs/sv-rSE/user/units-and-locale.md new file mode 100644 index 000000000..593b86bcd --- /dev/null +++ b/docs/sv-rSE/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Temperatur + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Altitud | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Hastighet + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Vind + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Strålning | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/tr-rTR/index.md b/docs/tr-rTR/index.md new file mode 100644 index 000000000..68c490a51 --- /dev/null +++ b/docs/tr-rTR/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Açıklaması | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/tr-rTR/user/connections.md b/docs/tr-rTR/user/connections.md new file mode 100644 index 000000000..480732ae6 --- /dev/null +++ b/docs/tr-rTR/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Bağlantılar +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Bağlantılar + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Açıklaması | +| ---- | ---------------- | ----------------------------- | +| 🟢 | Bağlandı | Active radio link established | +| 🟡 | Bağlanıyor | Handshake in progress | +| 🔴 | Bağlantı kesildi | No active connection | +| ⚪ | Not configured | No device selected | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Yapılandırma + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/tr-rTR/user/desktop.md b/docs/tr-rTR/user/desktop.md new file mode 100644 index 000000000..4271ca403 --- /dev/null +++ b/docs/tr-rTR/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Genel Bakış + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Notes | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Harita | ✓ | ✓ | Full parity | +| Ayarlar | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/tr-rTR/user/discovery.md b/docs/tr-rTR/user/discovery.md new file mode 100644 index 000000000..41d3c587b --- /dev/null +++ b/docs/tr-rTR/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Yol izle + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Komşu Bilgisi + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/tr-rTR/user/firmware.md b/docs/tr-rTR/user/firmware.md new file mode 100644 index 000000000..b2ab14c04 --- /dev/null +++ b/docs/tr-rTR/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - Kablosuz Güncelleme + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Kanal | Açıklaması | +| ------ | ------------------------------------------- | +| Stable | Recommended for most users; tested releases | +| Alpha | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/tr-rTR/user/map-and-waypoints.md b/docs/tr-rTR/user/map-and-waypoints.md new file mode 100644 index 000000000..ef167cb38 --- /dev/null +++ b/docs/tr-rTR/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------ | ---------------------------------------------- | +| Yeşil | Online (heard recently) | +| Yellow | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Mavi | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Açıklaması | +| ---------- | ------------------------------------------------------- | +| İsmi | Short identifier (max 30 characters) | +| Açıklaması | Optional longer description | +| Icon | Visual marker emoji on the map | +| Kilitli | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/tr-rTR/user/messages-and-channels.md b/docs/tr-rTR/user/messages-and-channels.md new file mode 100644 index 000000000..63cb71290 --- /dev/null +++ b/docs/tr-rTR/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Kanallar + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Channel Security + +Channels support multiple encryption levels: + +| Icon | Security Level | Açıklaması | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Delivered | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Hata | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Hata | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Zaman Aşımı | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Arayüz Yok | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Kanal yok | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| No Response | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Geçersiz İstek | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/tr-rTR/user/mqtt.md b/docs/tr-rTR/user/mqtt.md new file mode 100644 index 000000000..baad01bf7 --- /dev/null +++ b/docs/tr-rTR/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Genel Bakış + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Yapılandırma + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Açıklaması | Varsayılan | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Kullanıcı adı | Broker authentication | meshdev | +| Şifre | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Encryption | Encrypt MQTT payload | Açık | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Açıklaması | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Açıklaması | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/tr-rTR/user/node-metrics.md b/docs/tr-rTR/user/node-metrics.md new file mode 100644 index 000000000..51f1c2db1 --- /dev/null +++ b/docs/tr-rTR/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Device Metrics + +Basic operating information reported by each node: + +| Metric | Açıklaması | +| --------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Voltaj | Battery voltage reading | +| Kanal Kullanımı | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Çalışma Süresi | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Environment Metrics + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Sıcaklık | BME280, BME680, SHT31 | +| Nem | BME280, BME680, SHT31 | +| Barometrik Basınç | BME280, BMP280 | +| Gaz Direnci | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Açıklaması | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ---------- | +| > 10 dB | Excellent | +| 0 to 10 dB | İyi | +| -10 to 0 dB | İdare Eder | +| < -10 dB | Poor | + +## Power Metrics + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Açıklaması | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Akım | Power draw in milliamps | +| Güç | Calculated wattage | + +## Yol izle + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Konum Kayıtları + +Historical position data for nodes that share their location: + +- GPS coordinates +- Rakım +- Speed (if moving) +- Timestamp for each position report + +## Komşu Bilgisi + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/tr-rTR/user/nodes.md b/docs/tr-rTR/user/nodes.md new file mode 100644 index 000000000..366fa6600 --- /dev/null +++ b/docs/tr-rTR/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Nodelar +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Nodelar + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Rol | Açıklaması | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Client | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Tracker | Optimized for position reporting at regular intervals | +| Sensor | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - View on map + - Konum iste + - Mark as favorite + - Yol izle + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Filtre | Açıklaması | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Açıklaması | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Battery level | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Son duyulma | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Mesafe | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/tr-rTR/user/onboarding.md b/docs/tr-rTR/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/tr-rTR/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/tr-rTR/user/settings-module-admin.md b/docs/tr-rTR/user/settings-module-admin.md new file mode 100644 index 000000000..d24d7fa03 --- /dev/null +++ b/docs/tr-rTR/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Açıklaması | +| --------------- | ------------------------------------------------------------------------ | +| Açık | Toggle MQTT bridge | +| Sunucu | MQTT broker address | +| Kullanıcı adı | Authentication username | +| Şifre | Authentication password | +| Encryption | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Açıklaması | +| ---------- | ------------------------------- | +| Açık | Activate serial communication | +| Echo | Echo received serial data back | +| Mod | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Açıklaması | +| -------------------------------- | --------------------------- | +| Açık | Activate notifications | +| Uyarı Mesajı | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Aktif | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Açıklaması | +| ------------------------------------------ | -------------------------- | +| Açık | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Açıklaması | +| -------------------------------------- | --------------------------------- | +| Açık | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Açıklaması | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Açıklaması | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Mesajlar | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Açıklaması | +| --------------- | -------------------------------- | +| Açık | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Açıklaması | +| -------------------- | --------------------------------------------------------------- | +| Açık | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Açıklaması | +| -------------------------------------- | ------------------------------------ | +| Açık | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Açıklaması | +| ------------------ | ---------------------------------------------------------- | +| Açık | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Açıklaması | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Açık | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Açıklaması | +| -------------------------------------- | -------------------------- | +| Açık | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Yönetim + +### Uzaktan Yönetim + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Clean Node Database + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Yeniden başlat + +Remotely reboot a connected or administered node. + +### Hata Ayıklama Paneli + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/tr-rTR/user/settings-radio-user.md b/docs/tr-rTR/user/settings-radio-user.md new file mode 100644 index 000000000..ae51f8f98 --- /dev/null +++ b/docs/tr-rTR/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - ayarlar + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Açıklaması | +| ----------------- | ------------------------------------------------------------------------------------- | +| Uzun Ad | Your display name (up to 39 characters) | +| Kısa Ad | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Cihaz Ayarı + +| Setting | Açıklaması | Varsayılan | +| ------------------------------------------ | ----------------------------------------------------------------------- | ---------- | +| Rol | Node behavior (Client, Router, etc.) | Client | +| Rebroadcast Mode | How the node retransmits messages | Hepsi | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa Ayarı + +| Setting | Açıklaması | Varsayılan | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Bölge | Regulatory region for frequency bands | Unset (must configure) | +| Modem Ön Ayarı | Speed/range tradeoff | LongFast | +| Hop Limiti | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Speed | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Akran Ayarı + +| Setting | Açıklaması | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Display Units | Metric or Imperial | +| OLED Tipi | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Konum Ayarı + +| Setting | Açıklaması | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Smart Position | Enable movement-based broadcasting | +| Fixed Position | Use a manually set position | + +### Güç Ayarı + +| Setting | Açıklaması | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Ağ Ayarı + +| Setting | Açıklaması | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Ağ şifresi | +| NTP Sunucusu | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Bluetooth Ayarı + +| Setting | Açıklaması | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Sabit PIN | PIN code for pairing (default: 123456) | + +### Güvenlik Ayarı + +| Setting | Açıklaması | +| --------------------- | -------------------------------------------------------------------------- | +| Genel Anahtar | Your node's public key (read-only) | +| Yönetici Anahtarı | Key for remote administration | +| Özel Anahtar | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Yönetilen Mod | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/tr-rTR/user/signal-meter.md b/docs/tr-rTR/user/signal-meter.md new file mode 100644 index 000000000..fb0850b1e --- /dev/null +++ b/docs/tr-rTR/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ---------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| İyi | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| İdare Eder | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Kötü | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Yok | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/tr-rTR/user/tak.md b/docs/tr-rTR/user/tak.md new file mode 100644 index 000000000..c62ac0ef5 --- /dev/null +++ b/docs/tr-rTR/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Genel Bakış + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Yapılandırma + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Açıklaması | +| ------- | -------------------------- | +| Açık | Activate TAK interop | +| Mod | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Rol | Açıklaması | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Açıklaması | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Rol | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Özellikler | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/tr-rTR/user/telemetry-and-sensors.md b/docs/tr-rTR/user/telemetry-and-sensors.md new file mode 100644 index 000000000..627ca4b98 --- /dev/null +++ b/docs/tr-rTR/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Genel Bakış + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Açıklaması | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Voltaj | Battery voltage | 3.0–4.2V (LiPo) | +| Kanal Kullanımı | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Çalışma Süresi | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Sensor | Sıcaklık | Nem | Basınç | Notes | +| ------- | -------- | --- | ------ | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Sensor | Metric | Notes | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Sensor | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Power Metrics + +Nodes with INA-series power sensors can report: + +| Metric | Açıklaması | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Akım | Power consumption (mA) | +| Güç | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/tr-rTR/user/translate.md b/docs/tr-rTR/user/translate.md new file mode 100644 index 000000000..fe77da81f --- /dev/null +++ b/docs/tr-rTR/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Notes | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## Nasıl Katkıda Bulunulur + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Meshtastic'in erişimini genişletmemize yardımcı olduğunuz için teşekkür ederiz! diff --git a/docs/tr-rTR/user/units-and-locale.md b/docs/tr-rTR/user/units-and-locale.md new file mode 100644 index 000000000..1cda28685 --- /dev/null +++ b/docs/tr-rTR/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Sıcaklık + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Rakım | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Speed + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Rüzgar + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Radyasyon | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/uk-rUA/index.md b/docs/uk-rUA/index.md new file mode 100644 index 000000000..1e717192c --- /dev/null +++ b/docs/uk-rUA/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | Опис | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/uk-rUA/user/connections.md b/docs/uk-rUA/user/connections.md new file mode 100644 index 000000000..8daf8b49c --- /dev/null +++ b/docs/uk-rUA/user/connections.md @@ -0,0 +1,125 @@ +--- +title: Connections +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# Connections + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | Опис | +| ---- | -------------- | ----------------------------- | +| 🟢 | Під’єднано | Active radio link established | +| 🟡 | Під’єднання | Handshake in progress | +| 🔴 | Відключено | No active connection | +| ⚪ | Not configured | Не вибраний пристрій | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Налаштування + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/uk-rUA/user/desktop.md b/docs/uk-rUA/user/desktop.md new file mode 100644 index 000000000..1b4882a48 --- /dev/null +++ b/docs/uk-rUA/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## Overview + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## Installation + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | Нотатки | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| Мапа | ✓ | ✓ | Full parity | +| Налаштування | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/uk-rUA/user/discovery.md b/docs/uk-rUA/user/discovery.md new file mode 100644 index 000000000..8992b44bf --- /dev/null +++ b/docs/uk-rUA/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: Discovery +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# Discovery + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## Маршрут + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## Інформація про сусідів + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/uk-rUA/user/firmware.md b/docs/uk-rUA/user/firmware.md new file mode 100644 index 000000000..efb0d84a5 --- /dev/null +++ b/docs/uk-rUA/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - ota + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| Канал | Опис | +| --------- | ------------------------------------------- | +| Стабільна | Recommended for most users; tested releases | +| Альфа | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## Troubleshooting + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/uk-rUA/user/map-and-waypoints.md b/docs/uk-rUA/user/map-and-waypoints.md new file mode 100644 index 000000000..52d60ac65 --- /dev/null +++ b/docs/uk-rUA/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ------- | ---------------------------------------------- | +| Зелений | Online (heard recently) | +| Жовтий | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Синій | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | Опис | +| ---------- | ------------------------------------------------------- | +| Ім'я | Short identifier (max 30 characters) | +| Опис | Optional longer description | +| Icon | Visual marker emoji on the map | +| Блоковано | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/uk-rUA/user/messages-and-channels.md b/docs/uk-rUA/user/messages-and-channels.md new file mode 100644 index 000000000..b69f23537 --- /dev/null +++ b/docs/uk-rUA/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## Канали + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### Безпека каналу + +Channels support multiple encryption levels: + +| Icon | Security Level | Опис | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## Direct Messages + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| Доставлено | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| Error | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| Error | Meaning | What to Do | +| ------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Таймаут | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| Інтерфейс відсутній | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| Канал відсутній | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| Немає відповіді | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| Невірний запит | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/uk-rUA/user/mqtt.md b/docs/uk-rUA/user/mqtt.md new file mode 100644 index 000000000..a758ecfe5 --- /dev/null +++ b/docs/uk-rUA/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## Overview + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Налаштування + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Опис | За замовчуванням | +| ---------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| Ім'я користувача | Broker authentication | meshdev | +| Пароль | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| Шифрування | Encrypt MQTT payload | Увімкнено | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | Опис | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | Опис | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## Troubleshooting + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/uk-rUA/user/node-metrics.md b/docs/uk-rUA/user/node-metrics.md new file mode 100644 index 000000000..69c8f62c0 --- /dev/null +++ b/docs/uk-rUA/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## Показники пристрою + +Basic operating information reported by each node: + +| Metric | Опис | +| ------------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| Напруга | Battery voltage reading | +| Channel Utilization | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| Час роботи | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## Показники довкілля + +Environmental sensor data (requires compatible hardware): + +| Metric | Sensor Examples | +| ------------------------------------ | --------------------- | +| Температура | BME280, BME680, SHT31 | +| Вологість | BME280, BME680, SHT31 | +| Атмосферний тиск | BME280, BMP280 | +| Опір газового сенсора | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| Metric | Опис | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | ----------- | +| > 10 dB | Excellent | +| 0 to 10 dB | Хороший | +| -10 to 0 dB | Задовільний | +| < -10 dB | Poor | + +## Показники живлення + +Power management telemetry (requires INA sensor or compatible hardware): + +| Metric | Опис | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| Поточний | Power draw in milliamps | +| Живлення | Calculated wattage | + +## Маршрут + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## Position Log + +Historical position data for nodes that share their location: + +- GPS coordinates +- Висота +- Speed (if moving) +- Timestamp for each position report + +## Інформація про сусідів + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/uk-rUA/user/nodes.md b/docs/uk-rUA/user/nodes.md new file mode 100644 index 000000000..62c1c10d8 --- /dev/null +++ b/docs/uk-rUA/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: Вузли +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# Вузли + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| Роль | Опис | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Клієнт | Standard end-user device | +| Client Base | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Трекер | Optimized for position reporting at regular intervals | +| Датчик | Optimized for telemetry reporting | +| ТАК | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - Переглянути на мапі + - Запит місцезнаходження + - Mark as favorite + - Маршрут + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| Фільтри | Опис | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | Опис | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| --------------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| Рівень заряду батареї | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| Востаннє в мережі | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| Відстань | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/uk-rUA/user/onboarding.md b/docs/uk-rUA/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/uk-rUA/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/uk-rUA/user/settings-module-admin.md b/docs/uk-rUA/user/settings-module-admin.md new file mode 100644 index 000000000..b9c934b59 --- /dev/null +++ b/docs/uk-rUA/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## Module Configuration + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | Опис | +| ---------------- | ------------------------------------------------------------------------ | +| Увімкнено | Toggle MQTT bridge | +| Сервер | MQTT broker address | +| Ім'я користувача | Authentication username | +| Пароль | Authentication password | +| Шифрування | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | Опис | +| ---------- | ------------------------------- | +| Увімкнено | Activate serial communication | +| Echo | Echo received serial data back | +| Режим | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| Baud Rate | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | Опис | +| -------------------------------- | --------------------------- | +| Увімкнено | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | Опис | +| ------------------------------------------ | -------------------------- | +| Увімкнено | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | Опис | +| -------------------------------------- | --------------------------------- | +| Увімкнено | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | Опис | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| Air Quality Enabled | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | Опис | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| Повідомлення | Newline-separated list of messages | +| Send Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | Опис | +| --------------- | -------------------------------- | +| Увімкнено | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | Опис | +| -------------------- | --------------------------------------------------------------- | +| Увімкнено | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | Опис | +| -------------------------------------- | ------------------------------------ | +| Увімкнено | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | Опис | +| ------------------ | ---------------------------------------------------------- | +| Увімкнено | Activate LED control | +| LED State | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | Опис | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Увімкнено | Activate detection sensor | +| Monitor Pin | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| Send Bell | Include bell character in alerts | +| Friendly Name | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | Опис | +| -------------------------------------- | -------------------------- | +| Увімкнено | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## Адміністрування + +### Віддалене керування + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### Очистити базу даних вузлів + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### Перевантажити + +Remotely reboot a connected or administered node. + +### Панель налагодження + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/uk-rUA/user/settings-radio-user.md b/docs/uk-rUA/user/settings-radio-user.md new file mode 100644 index 000000000..7a6c89465 --- /dev/null +++ b/docs/uk-rUA/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - налаштування + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## User Settings + +### User Profile + +| Setting | Опис | +| ----------------- | ------------------------------------------------------------------------------------- | +| Довга назва | Your display name (up to 39 characters) | +| Коротка назва | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## Radio Configuration + +### Налаштування пристрою + +| Setting | Опис | За замовчуванням | +| ------------------------------------------ | ----------------------------------------------------------------------- | ---------------- | +| Роль | Node behavior (Client, Router, etc.) | Клієнт | +| Режим ретрансляції | How the node retransmits messages | Усі | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### Налаштування LoRa + +| Setting | Опис | За замовчуванням | +| ----------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| Регіон | Regulatory region for frequency bands | Unset (must configure) | +| Modem Preset | Speed/range tradeoff | LongFast | +| Hop Limit | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| Frequency Offset | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | Швидкість | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### Налаштування дисплею + +| Setting | Опис | +| ------------------- | ------------------------------------------------------------------------------------ | +| Screen Timeout | Time before display sleeps | +| Одиниці виміру | Metric or Imperial | +| Тип OLED | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### Position Config + +| Setting | Опис | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS Update Interval | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| Інтелектуальне передавання позиції | Enable movement-based broadcasting | +| Фіксована позиція | Use a manually set position | + +### Налаштування живлення + +| Setting | Опис | +| --------------------------------------- | --------------------------------------- | +| Power Saving | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### Налаштування мережі + +| Setting | Опис | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | Network password | +| NTP-сервер | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### Налаштування Bluetooth + +| Setting | Опис | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| Pairing Mode | Fixed PIN, Random PIN, or No PIN | +| Фіксований PIN | PIN code for pairing (default: 123456) | + +### Налаштування безпеки + +| Setting | Опис | +| --------------------- | -------------------------------------------------------------------------- | +| Відкритий ключ | Your node's public key (read-only) | +| Ключ адміністратора | Key for remote administration | +| Приватний ключ | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| Керований режим | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/uk-rUA/user/signal-meter.md b/docs/uk-rUA/user/signal-meter.md new file mode 100644 index 000000000..6b28b8a6b --- /dev/null +++ b/docs/uk-rUA/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----------- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| Хороший | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| Задовільний | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| Поганий | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| Жоден | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/uk-rUA/user/tak.md b/docs/uk-rUA/user/tak.md new file mode 100644 index 000000000..0c34cad87 --- /dev/null +++ b/docs/uk-rUA/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## Overview + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### Prerequisites + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Налаштування + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | Опис | +| --------- | -------------------------- | +| Увімкнено | Activate TAK interop | +| Режим | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| Роль | Опис | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | Опис | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| Роль | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | Features | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## Troubleshooting + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/uk-rUA/user/telemetry-and-sensors.md b/docs/uk-rUA/user/telemetry-and-sensors.md new file mode 100644 index 000000000..e6215523f --- /dev/null +++ b/docs/uk-rUA/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## Overview + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| Metric | Опис | Typical Range | +| ------------------- | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| Напруга | Battery voltage | 3.0–4.2V (LiPo) | +| Channel Utilization | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| Час роботи | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| Датчик | Температура | Вологість | Атмосферний тиск | Нотатки | +| ------- | ----------- | --------- | ---------------- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| Датчик | Metric | Нотатки | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| Датчик | Metric | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## Показники живлення + +Nodes with INA-series power sensors can report: + +| Metric | Опис | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| Поточний | Power consumption (mA) | +| Живлення | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## Troubleshooting + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/uk-rUA/user/translate.md b/docs/uk-rUA/user/translate.md new file mode 100644 index 000000000..cb9e62891 --- /dev/null +++ b/docs/uk-rUA/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | Нотатки | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/uk-rUA/user/units-and-locale.md b/docs/uk-rUA/user/units-and-locale.md new file mode 100644 index 000000000..54d5c0f2d --- /dev/null +++ b/docs/uk-rUA/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## Температура + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | Висота | +| -------------------------------- | -------------- | ---------------------- | -------- | +| Metric | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## Швидкість + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 12 km/h | +| Imperial (US) | 7 mph | + +## Вітер + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| Metric | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| Metric | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| Радіація | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/zh-rCN/index.md b/docs/zh-rCN/index.md new file mode 100644 index 000000000..0e04bb3a9 --- /dev/null +++ b/docs/zh-rCN/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | 说明 | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/zh-rCN/user/connections.md b/docs/zh-rCN/user/connections.md new file mode 100644 index 000000000..30c21611b --- /dev/null +++ b/docs/zh-rCN/user/connections.md @@ -0,0 +1,125 @@ +--- +title: 连接数 +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - bluetooth + - usb + - tcp + - pairing +--- + +# 连接数 + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| 图标 | State | 说明 | +| -- | -------------- | ----------------------------- | +| 🟢 | 已连接 | Active radio link established | +| 🟡 | 正在连接 | Handshake in progress | +| 🔴 | 已断开连接 | No active connection | +| ⚪ | Not configured | 未选择设备 | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### Setup + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### Configuration + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/zh-rCN/user/desktop.md b/docs/zh-rCN/user/desktop.md new file mode 100644 index 000000000..51f0915af --- /dev/null +++ b/docs/zh-rCN/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## 总览 + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## 安装 + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | 注 | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| 地图 | ✓ | ✓ | Full parity | +| 设置 | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| Notifications | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | 打开设置 | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +Requirements: + +- JDK 21 +- No Android SDK required for desktop-only builds + +## Known Limitations + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/zh-rCN/user/discovery.md b/docs/zh-rCN/user/discovery.md new file mode 100644 index 000000000..752ba4fad --- /dev/null +++ b/docs/zh-rCN/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: 发现 +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - neighbor-info +--- + +# 发现 + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## 追踪器 + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## 邻居信息 + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/zh-rCN/user/firmware.md b/docs/zh-rCN/user/firmware.md new file mode 100644 index 000000000..9a18af210 --- /dev/null +++ b/docs/zh-rCN/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: 固件升级 +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - OTA（空中升级） + - flash +--- + +# 固件升级 + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| 频道 | 说明 | +| ---- | ------------------------------------------- | +| 稳定版本 | Recommended for most users; tested releases | +| 开发版本 | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## 问题排查 + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/zh-rCN/user/map-and-waypoints.md b/docs/zh-rCN/user/map-and-waypoints.md new file mode 100644 index 000000000..d776cd4e7 --- /dev/null +++ b/docs/zh-rCN/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| 颜色 | Meaning | +| ---- | ---------------------------------------------- | +| 绿 | Online (heard recently) | +| 黄色 | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| 蓝 | Your own node | + +### Map Controls + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | 说明 | +| ---------- | ------------------------------------------------------- | +| 名称 | Short identifier (max 30 characters) | +| 说明 | Optional longer description | +| 图标 | Visual marker emoji on the map | +| 锁定 | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/zh-rCN/user/messages-and-channels.md b/docs/zh-rCN/user/messages-and-channels.md new file mode 100644 index 000000000..04cb6c5e5 --- /dev/null +++ b/docs/zh-rCN/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - channels + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## 频道 + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### 频道安全 + +Channels support multiple encryption levels: + +| 图标 | Security Level | 说明 | +| -- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## 私聊 + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | 图标 | Meaning | +| --------------------------------- | -- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| 已发送 | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| 错误 | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| 错误 | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 找不到目标 | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| 超时 | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| 无连接 | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| 没有频道 | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| 无响应 | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| 错误请求 | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## Best Practices + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/zh-rCN/user/mqtt.md b/docs/zh-rCN/user/mqtt.md new file mode 100644 index 000000000..145e7c937 --- /dev/null +++ b/docs/zh-rCN/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - mqtt + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## 总览 + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## How It Works + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## Configuration + +### Enabling MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | 说明 | 默认 | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| Server Address | MQTT broker hostname | mqtt.meshtastic.org | +| 用户名称 | Broker authentication | meshdev | +| 密码 | Broker authentication | large4cats | +| Root Topic | Base topic for messages | msh | +| 加密 | Encrypt MQTT payload | Enabled | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | 禁用 | +| TLS | Secure connection to broker | 禁用 | +| Map Reporting | Report position to public map | 禁用 | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | 说明 | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | 说明 | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## Best Practices + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## 问题排查 + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/zh-rCN/user/node-metrics.md b/docs/zh-rCN/user/node-metrics.md new file mode 100644 index 000000000..52b98ce5d --- /dev/null +++ b/docs/zh-rCN/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - telemetry + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## 设备数据 + +Basic operating information reported by each node: + +| 公制 | 说明 | +| ------ | ----------------------------------- | +| 电池电量 | Current battery percentage | +| 电压 | Battery voltage reading | +| 频道利用率 | Percentage of airtime consumed | +| 广播时间 | Transmission time used by this node | +| 正常运行时间 | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## 传感器指标 + +Environmental sensor data (requires compatible hardware): + +| 公制 | Sensor Examples | +| ------------------------------------ | --------------------- | +| 温度 | BME280, BME680, SHT31 | +| 湿度 | BME280, BME680, SHT31 | +| 气压 | BME280, BMP280 | +| 气体电阻性 | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## 信号强度 + +Radio signal quality information: + +| 公制 | 说明 | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| Hop Count | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | 良好 | +| -10 to 0 dB | 一般 | +| < -10 dB | Poor | + +## 电源计量 + +Power management telemetry (requires INA sensor or compatible hardware): + +| 公制 | 说明 | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| 电流 | Power draw in milliamps | +| 电源 | Calculated wattage | + +## 追踪器 + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## 定位日志 + +Historical position data for nodes that share their location: + +- GPS coordinates +- 海拔高度 +- Speed (if moving) +- Timestamp for each position report + +## 邻居信息 + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/zh-rCN/user/nodes.md b/docs/zh-rCN/user/nodes.md new file mode 100644 index 000000000..5fd9cfa50 --- /dev/null +++ b/docs/zh-rCN/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: 节点 +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# 节点 + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| 角色 | 说明 | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 客户端 | Standard end-user device | +| 客户群 | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| 客户端静默 | Receives but doesn't retransmit | +| 客户端隐藏 | Like Client Mute, plus hides from node list | +| 路由 | Prioritizes message forwarding; stays awake to relay | +| 延迟时间 | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| 追踪器 | Optimized for position reporting at regular intervals | +| 传感器 | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK 追踪器 | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| 图标 | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - 查看地图 + - 请求位置 + - Mark as favorite + - 追踪器 + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| 搜索节点 | 说明 | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | 说明 | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | Screenshot | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| 电池电量 | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| 最后听到 | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| 距离 | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/zh-rCN/user/onboarding.md b/docs/zh-rCN/user/onboarding.md new file mode 100644 index 000000000..3b910534e --- /dev/null +++ b/docs/zh-rCN/user/onboarding.md @@ -0,0 +1,99 @@ +--- +title: Getting Started +nav_order: 1 +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# Getting Started + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/zh-rCN/user/settings-module-admin.md b/docs/zh-rCN/user/settings-module-admin.md new file mode 100644 index 000000000..22034190e --- /dev/null +++ b/docs/zh-rCN/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - module-config + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## 模块配置 + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| Setting | 说明 | +| --------------- | ------------------------------------------------------------------------ | +| Enabled | Toggle MQTT bridge | +| 服务器 | MQTT broker address | +| 用户名称 | Authentication username | +| 密码 | Authentication password | +| 加密 | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| Root Topic | Base MQTT topic path | +| 地图报告 | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| Setting | 说明 | +| ---------- | ------------------------------- | +| Enabled | Activate serial communication | +| 回声 | Echo received serial data back | +| 模式 | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| 波特率 | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| Setting | 说明 | +| -------------------------------- | --------------------------- | +| Enabled | Activate notifications | +| 提醒消息 | Notify on incoming messages | +| 警告消息蜂鸣 | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| 提醒铃声 | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| 启用 | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| Setting | 说明 | +| ------------------------------------------ | -------------------------- | +| Enabled | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| Records | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| Setting | 说明 | +| -------------------------------------- | --------------------------------- | +| Enabled | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| Setting | 说明 | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| 启用空气质量检测 | Report particulate sensor data | +| Power Metrics Enabled | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| Setting | 说明 | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| 消息 | Newline-separated list of messages | +| 发送铃声 | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| Setting | 说明 | +| --------------- | -------------------------------- | +| Enabled | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S Word Select | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| Setting | 说明 | +| -------------------- | --------------------------------------------------------------- | +| Enabled | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| Setting | 说明 | +| -------------------------------------- | ------------------------------------ | +| Enabled | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| Setting | 说明 | +| ------------------ | ---------------------------------------------------------- | +| Enabled | Activate LED control | +| LED 状态 | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| Setting | 说明 | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| Enabled | Activate detection sensor | +| 监视器 | GPIO pin connected to sensor | +| Detection Triggered High | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| 发送铃声 | Include bell character in alerts | +| 友好名称 | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting | 说明 | +| -------------------------------------- | -------------------------- | +| Enabled | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## 管理员 + +### 远程管理 + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### 清理节点数据库 + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### Factory Reset + +Resets all settings to factory defaults. **This cannot be undone.** + +### 重启 + +Remotely reboot a connected or administered node. + +### 调试面板 + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/zh-rCN/user/settings-radio-user.md b/docs/zh-rCN/user/settings-radio-user.md new file mode 100644 index 000000000..0bb0e5e9d --- /dev/null +++ b/docs/zh-rCN/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - 设置 + - radio-config + - user-config + - lora +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## 用户设置 + +### User Profile + +| Setting | 说明 | +| ------- | ------------------------------------------------------------------------------------- | +| 长名称 | Your display name (up to 39 characters) | +| 短名称 | 4-character abbreviated name | +| 持证操作员 | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## 电台配置 + +### 设备配置 + +| Setting | 说明 | 默认 | +| ------------------------------------------ | ----------------------------------------------------------------------- | ----- | +| 角色 | Node behavior (Client, Router, etc.) | 客户端 | +| 转播模式 | How the node retransmits messages | 全部 | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | 禁用 | + +### LoRa 配置 + +| Setting | 说明 | 默认 | +| --------------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| 区域 | Regulatory region for frequency bands | Unset (must configure) | +| 调制解调器预设 | Speed/range tradeoff | LongFast | +| 跳跃数限制 | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| 频率偏移(MHz | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | Range | 速度 | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| Short Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| Short Fast | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| Short Slow | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| Medium Fast | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| Medium Slow | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| Long Moderate | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### 屏幕配置 + +| Setting | 说明 | +| ------------------- | ------------------------------------------------------------------------------------ | +| 屏幕超时时间 | Time before display sleeps | +| 显示单位 | Metric or Imperial | +| OLED 类型 | Auto, SSD1306, SH1106, SH1107 | +| Compass Orientation | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### 定位配置 + +| Setting | 说明 | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS更新间隔 | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| 智能位置 | Enable movement-based broadcasting | +| 固定位置 | Use a manually set position | + +### 电源配置 + +| Setting | 说明 | +| --------------------------------------- | --------------------------------------- | +| 省电模式 | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### 网络配置 + +| Setting | 说明 | +| ------------- | ---------------------------------------------------- | +| WiFi Enabled | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | 网络密码 | +| NTP 服务器地址 | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### 蓝牙配置 + +| Setting | 说明 | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| 配对模式 | Fixed PIN, Random PIN, or No PIN | +| 固定PIN码 | PIN code for pairing (default: 123456) | + +### 安全配置 + +| Setting | 说明 | +| --------------------- | -------------------------------------------------------------------------- | +| 公钥 | Your node's public key (read-only) | +| 管理员密钥 | Key for remote administration | +| 私钥 | Your node's private key (handle securely) | +| Admin Channel Enabled | Allow admin commands via channel | +| Debug Log | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| 管理模式 | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | Screenshot | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/zh-rCN/user/signal-meter.md b/docs/zh-rCN/user/signal-meter.md new file mode 100644 index 000000000..af2a09726 --- /dev/null +++ b/docs/zh-rCN/user/signal-meter.md @@ -0,0 +1,81 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | ---- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| 良好 | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| 一般 | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| 差 | 1 | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| 无 | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/zh-rCN/user/tak.md b/docs/zh-rCN/user/tak.md new file mode 100644 index 000000000..c5ecfdc49 --- /dev/null +++ b/docs/zh-rCN/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## 总览 + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## Setup + +### 前置条件 + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### Configuration + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| Setting | 说明 | +| ------- | -------------------------- | +| Enabled | Activate TAK interop | +| 模式 | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| 角色 | 说明 | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| Setting | 说明 | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| 角色 | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | Compatibility | 特性 | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## 问题排查 + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/zh-rCN/user/telemetry-and-sensors.md b/docs/zh-rCN/user/telemetry-and-sensors.md new file mode 100644 index 000000000..bbd80e8a4 --- /dev/null +++ b/docs/zh-rCN/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - 环境 + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## 总览 + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## Device Telemetry + +All Meshtastic nodes report basic device telemetry: + +| 公制 | 说明 | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| 电池电量 | Charge percentage | 0–100% | +| 电压 | Battery voltage | 3.0–4.2V (LiPo) | +| 频道利用率 | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| 正常运行时间 | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| 传感器 | 温度 | 湿度 | 气压 | 注 | +| ------- | -- | -- | -- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| 传感器 | 公制 | 注 | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| 传感器 | 公制 | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## 电源计量 + +Nodes with INA-series power sensors can report: + +| 公制 | 说明 | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| 电流 | Power consumption (mA) | +| 电源 | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## 问题排查 + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/zh-rCN/user/translate.md b/docs/zh-rCN/user/translate.md new file mode 100644 index 000000000..c80c943b6 --- /dev/null +++ b/docs/zh-rCN/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | 注 | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## How to Contribute + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +Thank you for helping expand the reach of Meshtastic! diff --git a/docs/zh-rCN/user/units-and-locale.md b/docs/zh-rCN/user/units-and-locale.md new file mode 100644 index 000000000..8eca4badd --- /dev/null +++ b/docs/zh-rCN/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## How It Works + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## 温度 + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | 海拔高度 | +| -------------------------------- | -------------- | ---------------------- | -------- | +| 公制 | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## 速度 + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| 公制 | 12 km/h | +| Imperial (US) | 7 mph | + +## 风 + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| 公制 | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| 公制 | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| Barometric pressure | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| 辐射 | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| Setting | What It Controls | Example | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. + diff --git a/docs/zh-rTW/index.md b/docs/zh-rTW/index.md new file mode 100644 index 000000000..2c919a7e8 --- /dev/null +++ b/docs/zh-rTW/index.md @@ -0,0 +1,30 @@ +--- +title: Home +layout: default +nav_order: 0 +--- + +# Meshtastic Android App Documentation + +User and developer documentation for the Meshtastic Android, Desktop, and iOS applications powered by KMP (Kotlin Multiplatform). + +Use the sidebar navigation to browse the **User Guide** for app features and the **Developer Guide** for contributing to the project. + +--- + +## Quick Links + +| Guide | 描述說明 | +| --------------------------------------------------------------------- | -------------------------------------------------------------- | +| [Getting Started](user/onboarding) | Connect your first radio and send a message | +| [Messages & Channels](user/messages-and-channels) | Channel broadcasts, direct messages, reactions, and encryption | +| [Nodes](user/nodes) | Understanding the mesh network node list | +| [Signal Meter](user/signal-meter) | How the LoRa signal quality meter works | +| [Units & Locale](user/units-and-locale) | How temperatures, distances, and times adapt to your region | +| [Desktop App](user/desktop) | Linux, macOS, and Windows desktop usage | +| [Architecture](developer/architecture) | App architecture overview for contributors | +| [Contributing](developer/contributing) | Branch naming, PR workflow, and verification commands | + +--- + +> This documentation is served from the same markdown source that powers the in-app **Help & Documentation** browser. diff --git a/docs/zh-rTW/user/connections.md b/docs/zh-rTW/user/connections.md new file mode 100644 index 000000000..7bc4b59ce --- /dev/null +++ b/docs/zh-rTW/user/connections.md @@ -0,0 +1,125 @@ +--- +title: 連線 +nav_order: 2 +last_updated: 2026-05-13 +description: Connect your phone or desktop to a Meshtastic radio via Bluetooth, USB, or TCP/IP. +aliases: + - 藍牙 + - usb + - tcp + - pairing +--- + +# 連線 + +Meshtastic supports multiple transport methods to communicate between your phone/desktop and a radio node. + +## Bluetooth (BLE) + +Bluetooth Low Energy is the default and most common connection method on Android. + +### Pairing a Device + +1. Ensure your Meshtastic radio is powered on and in pairing mode. +2. Open the app and navigate to **Connections**. +3. Tap **Scan for Devices** — nearby Meshtastic radios will appear. +4. Select your device from the list. +5. Accept the Bluetooth pairing prompt if shown. + +![Device list item](/assets/screenshots/connections_bluetooth_scan.png) + +You can filter devices by transport type using the filter chips at the top: + +![Transport filter chips](/assets/screenshots/connections_transport_filters.png) + +> 💡 **Tip:** If your device doesn't appear, check that Bluetooth and Location permissions are granted, and that the radio is not already connected to another device. + +### Connection Status + +| Icon | State | 描述說明 | +| ---- | -------------- | ----------------------------- | +| 🟢 | 已連線 | Active radio link established | +| 🟡 | 正在連線 | Handshake in progress | +| 🔴 | 已中斷連線 | No active connection | +| ⚪ | Not configured | 未選擇裝置 | + +When connecting, a status indicator shows the current connection state: + +![Connecting status](/assets/screenshots/connections_connecting.png) + +If no devices are found, the app shows an empty state with instructions: + +![No devices found](/assets/screenshots/connections_empty_state.png) + +### Troubleshooting Bluetooth + +- **Device not found:** Toggle Bluetooth off/on, ensure location is enabled. +- **Connection drops:** Move closer to the radio; check for interference. +- **Pairing rejected:** Forget the device in Android Bluetooth settings and retry. + +## USB Serial + +USB connections provide a wired alternative, useful for desktop or when Bluetooth is unavailable. + +### 設定 + +1. Connect your radio via USB cable to your device. +2. The app will prompt for USB permission — tap **Allow**. +3. The connection is established automatically. + +> ⚠️ **Note:** USB connections require OTG support on Android devices. + +## TCP/IP (WiFi) + +Some Meshtastic radios support WiFi connectivity, allowing TCP-based connections. + +### 設定 + +1. Connect your radio to a WiFi network via the radio's web interface or settings. +2. In the app, go to **Connections → TCP**. +3. Enter the radio's IP address and port (default: 4403). +4. Tap **Connect**. + +![WiFi scanning for devices](/assets/screenshots/connections_wifi_scanning.png) + +When a device is found, it appears in the connection list: + +![WiFi device found](/assets/screenshots/connections_wifi_device_found.png) + +A successful connection is confirmed with a status indicator: + +![WiFi connection success](/assets/screenshots/connections_wifi_success.png) + +### When to Use TCP + +- Radio is on the same local network +- Testing with a simulated radio +- Environments where Bluetooth has interference issues + +## Reconnection Behavior + +The app reconnects to the **last selected device** on startup. You can manually switch transports from the connections screen at any time. + +To disconnect from a radio, use the disconnect button on the connections screen: + +![Disconnect from radio](/assets/screenshots/connections_disconnect.png) + +## Desktop Connections + +On Desktop (Linux/macOS/Windows), the app supports: + +- **Bluetooth (BLE)** — via the Kable library; works on macOS, Linux, and Windows +- **USB Serial** — primary wired connection method +- **TCP/IP** — for network-connected radios + +See [Desktop App](desktop) for platform-specific details and keyboard shortcuts. + +## Related Topics + +- [Getting Started](onboarding) — first-launch setup and permissions +- [Settings — Radio & User](settings-radio-user) — Bluetooth and network configuration +- [Desktop App](desktop) — desktop-specific connection details +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — full list of compatible radios on meshtastic.org + +--- + diff --git a/docs/zh-rTW/user/desktop.md b/docs/zh-rTW/user/desktop.md new file mode 100644 index 000000000..f68a656a3 --- /dev/null +++ b/docs/zh-rTW/user/desktop.md @@ -0,0 +1,147 @@ +--- +title: Desktop App +nav_order: 14 +last_updated: 2026-05-13 +description: Install and use the Meshtastic Desktop app on Linux, macOS, and Windows — connections, feature parity, and keyboard shortcuts. +aliases: + - desktop + - linux + - macos + - windows + - jvm +--- + +# Desktop App + +The Meshtastic Desktop application provides the same mesh communication features on Linux, macOS, and Windows. + +## 概觀 + +The Desktop app shares its core codebase with the Android app through Kotlin Multiplatform (KMP). Most features work identically across platforms. + +## 安裝 + +### Linux + +- Download the `.deb` or `.AppImage` package from the releases page +- Or build from source using `./gradlew :desktopApp:run` + +### macOS + +- Download the `.dmg` package from releases +- Or build from source + +### Windows + +- Download the `.msi` installer from releases +- Or build from source + +## Connecting Your Radio + +### USB Serial (Primary) + +The most reliable connection method on Desktop: + +1. Connect your Meshtastic radio via USB cable. +2. The app should detect the serial port automatically. +3. If not detected, select the correct serial port from the connections menu. + +### TCP/IP + +For network-connected radios: + +1. Enter the radio's IP address and port (default: 4403). +2. Click **Connect**. + +### Bluetooth (BLE) + +Bluetooth Low Energy is supported on Desktop via the [Kable](https://github.com/JuulLabs/kable) library: + +1. Ensure your system has a Bluetooth adapter. +2. The app scans for nearby Meshtastic radios automatically. +3. Select your device from the connections screen. + +## Feature Parity + +| Feature | Android | Desktop | 備註 | +| ---------------------------------------- | ------- | ------- | -------------------------- | +| Messaging | ✓ | ✓ | Full parity | +| Node List | ✓ | ✓ | Full parity | +| 地圖 | ✓ | ✓ | Full parity | +| 設定 | ✓ | ✓ | Full parity | +| Bluetooth (BLE) | ✓ | ✓ | Via Kable on desktop | +| Firmware Update OTA | ✓ | ✗ | Use web flasher | +| 通知 | ✓ | ✓ | Native OS notifications | +| Widgets | ✓ | ✗ | Android-only | +| AI Assistant (Chirpy) | ✓\* | ✗ | Google flavor Android only | + +\*Chirpy AI requires Android 14+ on Google flavor builds with supported hardware. + +## UI Differences + +The Desktop app uses the same Compose Multiplatform UI with adaptations for larger screens and desktop interaction. + +### Keyboard Shortcuts + +| Shortcut | Action | +| ------------------- | --------------------------- | +| **⌘Q** / **Ctrl+Q** | Quit the application | +| **⌘,** / **Ctrl+,** | Open Settings | +| **⌘1** / **Ctrl+1** | Switch to Conversations tab | +| **⌘2** / **Ctrl+2** | Switch to Nodes tab | +| **⌘3** / **Ctrl+3** | Switch to Map tab | +| **⌘4** / **Ctrl+4** | Switch to Connections tab | + +### Window & System Tray + +- **Window resizing** — responsive layout adapts to window dimensions +- **System tray** — minimize to system tray for background mesh operation +- **Tray menu** — right-click the tray icon to show window or quit +- **Mouse interaction** — hover states and standard desktop navigation + +### Notification Preferences + +The Desktop app provides in-app toggles for controlling which notifications are shown — messages, new nodes, and low battery alerts. Access these from **Settings → Notifications** within the app. + +## Built-in Documentation Browser + +The Desktop app includes a built-in documentation browser for quick access to help content without leaving the application. + +![Docs browser with table of contents](/assets/screenshots/docs-browser_toc.png) + +The browser supports full-text search across all documentation: + +![Searching the docs browser](/assets/screenshots/docs-browser_search.png) + +Individual doc pages render with full formatting: + +![A documentation page](/assets/screenshots/docs-browser_page.png) + +## Building from Source + +```bash +git clone https://github.com/meshtastic/Meshtastic-Android.git +cd Meshtastic-Android +git submodule update --init +./gradlew :desktopApp:run +``` + +需求： + +- JDK 21 +- No Android SDK required for desktop-only builds + +## 已知限制 + +- No OTA firmware updates (use web flasher) +- Some Android-specific features (widgets, specific notification channels) are unavailable +- Performance may vary on low-spec hardware running Compose Desktop +- BLE bonding is not yet supported on desktop (pairing works without bonding) + +## Related Topics + +- [Connections](connections) — connection methods overview +- [Firmware Updates](firmware) — use the [Web Flasher](https://flasher.meshtastic.org) for desktop firmware updates + +--- + diff --git a/docs/zh-rTW/user/discovery.md b/docs/zh-rTW/user/discovery.md new file mode 100644 index 000000000..c0c43d9b4 --- /dev/null +++ b/docs/zh-rTW/user/discovery.md @@ -0,0 +1,114 @@ +--- +title: 尋找 +nav_order: 12 +last_updated: 2026-05-13 +description: Explore your mesh network — traceroute paths, neighbor maps, and node discovery tools. +aliases: + - mesh-discovery + - local-discovery + - network-scan + - traceroute + - 鄰居資訊 +--- + +# 尋找 + +Discovery tools help you understand **how** your mesh network is connected — which nodes can hear each other, what paths messages take, and where bottlenecks or weak links exist. + +> 💡 **Tip:** You don't need a dedicated "discovery mode" to start exploring your mesh. The tools below are available right now from the node list and node detail screens. + +--- + +## 路由追蹤 + +Traceroute reveals the exact path a message takes from your node to any other node on the mesh. It's the single most useful tool for debugging connectivity problems. + +### Running a Traceroute + +1. Navigate to **Nodes** and tap the node you want to trace. +2. On the node detail screen, tap **Traceroute**. +3. The app sends a traceroute request and waits for the response. +4. Results display each hop in order, with signal quality at every step. + +### Reading the Results + +A traceroute result looks like this: + +``` +You → Node A (SNR: 8.5, RSSI: -95) → Node B (SNR: 5.2, RSSI: -108) → Target +``` + +Each hop represents a relay node that forwarded the message. The SNR and RSSI values at each hop tell you about the link quality on that specific segment. + +| What to look for | What it means | +| -------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| All hops show Good SNR (> 5 dB) | Healthy path — messages flow reliably | +| One hop shows Bad SNR (< 0 dB) | Weak link — this relay segment is fragile | +| Many hops (4+) | Long path — consider repositioning a node to shorten it | +| Different path on retry | Mesh is adapting — multiple routes exist (this is good!) | + +> 💡 **Tip:** Run traceroute several times over a few minutes. If the path changes, your mesh has redundant routes — a sign of a well-connected network. + +### Troubleshooting with Traceroute + +- **"No route found"** — The target node may be offline, out of range, or on a different channel. Check that both nodes share at least one channel with the same encryption key. +- **Traceroute times out** — The path may be too long (exceeds hop limit) or a relay node is congested. Try increasing the hop limit in **Settings → LoRa Config**. +- **Asymmetric paths** — A traceroute from A→B may take a different path than B→A. This is normal — radio propagation is not always symmetric. + +--- + +## 鄰近節點資訊 + +The Neighbor Info module lets each node broadcast a list of the nodes it can **directly hear** (single-hop). When multiple nodes share their neighbor lists, you can piece together a topology map of the entire mesh. + +### Enabling Neighbor Info + +1. Navigate to **Settings → Module Config → Neighbor Info**. +2. Enable the module. +3. Set the broadcast interval (default: 900 seconds / 15 minutes). + +Once enabled, your node periodically broadcasts its neighbor table. Other nodes with Neighbor Info enabled do the same. + +### Viewing Neighbor Data + +- Open any node's detail screen and look for the **Neighbors** section. +- Each neighbor entry shows the node that was directly heard and its signal quality. +- Combine neighbor data from multiple nodes to understand the full mesh topology. + +> ⚠️ **Note:** Neighbor Info increases airtime usage because every enabled node periodically broadcasts its neighbor list. On busy meshes with many nodes, consider longer broadcast intervals (3600 seconds or more) to avoid congestion. + +--- + +## Node List as a Discovery Tool + +The node list itself is a powerful discovery tool when you use its filtering and sorting features effectively. + +### Finding New Nodes + +- Sort by **Last heard** to see the most recently active nodes at the top. +- Enable **Include unknown** to see nodes that have appeared on the mesh but haven't sent user info yet — these are often newly powered-on devices. + +### Assessing Connectivity + +- Sort by **Hops away** to see which nodes are directly reachable (0 hops) versus relayed. +- Sort by **Distance** to find nearby nodes and verify they're reachable. +- Use **Exclude MQTT** to focus on nodes reachable over radio (not via internet bridge). + +### Infrastructure Audit + +- Disable **Exclude infrastructure** to see Router, Repeater, Router Late, and Client Base nodes. +- Check their signal quality and last-heard times to verify your infrastructure nodes are healthy. + +See [Nodes](nodes) for full details on filtering and sorting options. + +--- + +## Tips for Mesh Exploration + +- **Start with traceroute** — it gives you immediate, actionable information about a specific path. +- **Enable Neighbor Info on key nodes** — especially routers and repeaters, to build a picture of the backbone. +- **Check the map** — node positions on the [Map](map-and-waypoints) combined with signal data help you understand why some links are strong and others are weak. +- **Compare signal over time** — use the [Signal Meter](signal-meter) guide to interpret SNR and RSSI values correctly. + +--- + diff --git a/docs/zh-rTW/user/firmware.md b/docs/zh-rTW/user/firmware.md new file mode 100644 index 000000000..e1cdf4838 --- /dev/null +++ b/docs/zh-rTW/user/firmware.md @@ -0,0 +1,114 @@ +--- +title: Firmware Updates +nav_order: 13 +last_updated: 2026-05-13 +description: Update your radio firmware over Bluetooth — OTA process, version channels, pre-flight checks, and recovery. +aliases: + - firmware + - update + - OTA（空中升级） + - flash +--- + +# Firmware Updates + +Keep your Meshtastic radio up to date with the latest firmware for new features, bug fixes, and security improvements. + +## Checking for Updates + +1. Navigate to **Settings → Firmware Update** or tap the firmware notification if shown. +2. The app checks for available firmware versions. +3. Available updates show the version number and changelog summary. + +## Update Methods + +### OTA (Over-The-Air) via Bluetooth + +The most common update method for Android users: + +1. Ensure your radio is connected via Bluetooth. +2. Navigate to the Firmware Update screen. +3. Select the desired firmware version. +4. Tap **Update** to begin the OTA process. +5. Wait for the update to complete — **do not disconnect** during the update. + +![Firmware checking for updates](/assets/screenshots/firmware_checking.png) + +> ⚠️ **Warning:** Interrupting a firmware update can brick your device. Ensure your radio has sufficient battery (>50% recommended) and maintain Bluetooth proximity during the entire process. + +![Firmware disclaimer](/assets/screenshots/firmware_disclaimer.png) + +### USB Flashing + +For recovery or when OTA is unavailable: + +- Use the [Meshtastic Web Flasher](https://flasher.meshtastic.org) +- Or the [Meshtastic CLI tool](https://meshtastic.org/docs/getting-started/flashing-firmware) on desktop + +## Version Channels + +| 頻道 | 描述說明 | +| --------- | ------------------------------------------- | +| 穩定版 | Recommended for most users; tested releases | +| Alpha 測試版 | Preview releases; may contain bugs | + +## Pre-Update Checklist + +Before updating: + +- [ ] Battery > 50% +- [ ] Stable Bluetooth connection +- [ ] Note your current settings (they may reset on major version changes) +- [ ] Check the release notes for breaking changes + +## Post-Update + +After a successful update: + +- The radio will reboot automatically +- Bluetooth connection will re-establish +- Verify your settings are intact +- Check the firmware version in **Settings → About** + +![Firmware update success](/assets/screenshots/firmware_success.png) + +## 故障排除 + +### Update Stuck + +If the update appears frozen: + +- Wait at least 5 minutes before intervening +- If truly stuck, power-cycle the radio +- Attempt the update again + +![Firmware update error](/assets/screenshots/firmware_error.png) + +### Device Won't Boot After Update + +If your device fails to boot: + +1. Try connecting via USB to a computer +2. Use the web flasher in recovery/DFU mode +3. Flash a known-good firmware version +4. Check the Meshtastic Discord for device-specific recovery steps + +### Compatibility Warnings + +The app may show warnings when: + +- Connected radio firmware is below minimum supported version +- Major version mismatch between app and firmware +- Deprecated features need migration + +> ⚠️ **Important:** Always update the Meshtastic app before or alongside firmware updates to ensure compatibility. + +## Related Topics + +- [Connections](connections) — reconnecting after a firmware update +- [Flashing firmware guide](https://meshtastic.org/docs/getting-started/flashing-firmware) — full firmware flashing walkthrough on meshtastic.org +- [Supported devices](https://meshtastic.org/docs/hardware/devices) — check firmware compatibility by device +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/zh-rTW/user/map-and-waypoints.md b/docs/zh-rTW/user/map-and-waypoints.md new file mode 100644 index 000000000..4fc7eb7f8 --- /dev/null +++ b/docs/zh-rTW/user/map-and-waypoints.md @@ -0,0 +1,116 @@ +--- +title: Map & Waypoints +nav_order: 6 +last_updated: 2026-05-13 +description: View node positions on the map, create and share waypoints, and manage position sharing and privacy. +aliases: + - map + - waypoints + - gps + - location +--- + +# Map & Waypoints + +The Map screen shows the geographic positions of nodes on your mesh, along with shared waypoints. + +## Map View + +The map displays: + +- **Node positions** — colored markers for each node reporting location +- **Waypoints** — shared points of interest +- **Your position** — your current GPS location + +### Node Markers + +Node markers on the map indicate: + +| Color | Meaning | +| ---------- | ---------------------------------------------- | +| Green - 綠色 | Online (heard recently) | +| 黃色 | Away (heard within 2 hours) | +| Gray | Offline (stale position) | +| Blue - 藍色 | 你自己的節點 | + +### 地圖控制項 + +- **Zoom** — pinch or use +/- buttons +- **Pan** — drag to explore +- **Center** — select the location button to center on your position +- **Node tap** — tap a node marker to view details + +The floating toolbar provides quick access to compass, layer switching, node filters, refresh, and location tracking. Tap the compass to reorient north-up, or tap the location button to center on your current position. + +![Map controls overlay](/assets/screenshots/map_controls_overlay.png) + +## Waypoints + +Waypoints are shared geographic points of interest that all mesh members can see. + +### Creating a Waypoint + +1. Long-press on the map at the desired location. +2. Enter a name and optional description. +3. Choose an icon/emoji for the waypoint. +4. Tap **Send** to share with the mesh. + +### Waypoint Properties + +| Property | 描述說明 | +| ---------- | ------------------------------------------------------- | +| 名稱 | Short identifier (max 30 characters) | +| 描述說明 | Optional longer description | +| Icon | Visual marker emoji on the map | +| 鎖定 | If locked, only the creator can edit or delete | +| Expiration | Optional auto-remove time | + +### Waypoint Expiration + +Waypoints can be set to expire automatically: + +- **Never** (default) — waypoint remains until manually deleted +- **Timed** — waypoint is automatically removed after the specified duration (e.g., "remove after 2 hours"). Useful for temporary markers like rally points, hazards, or meeting locations. + +Expired waypoints are automatically hidden from the map so they don't clutter the display. The expiration countdown begins when the waypoint is created, not when other nodes receive it. + +### Managing Waypoints + +- Tap a waypoint on the map to view its details and coordinates +- Edit or delete waypoints you created +- **Locked waypoints** cannot be modified or deleted by other nodes — only the original creator can change them +- Unlocked waypoints can be edited by any mesh member + +## Position Sharing + +### Enabling Position Sharing + +Your node shares its GPS position based on: + +- **Fixed interval** — broadcast position at regular intervals +- **Smart position** — broadcast when movement exceeds a threshold +- **Manual** — only share when explicitly requested + +Configure position behavior in **Settings → Position**. + +### Privacy Considerations + +> 🔒 **Privacy:** Position data is broadcast to all nodes on your channel. If you don't want your location shared, disable GPS position in settings or use a fixed/fake position. + +## Map Sources + +The app supports multiple map tile sources: + +- OpenStreetMap (default) +- Satellite imagery (where available) +- Offline tiles (download map areas for offline use) + +## Related Topics + +- [Nodes](nodes) — view and filter your node list +- [Node Metrics](node-metrics) — signal quality and position history for individual nodes +- [Discovery](discovery) — traceroute and neighbor info for understanding mesh topology +- [Units & Locale](units-and-locale) — distance and coordinate display formats + +--- + diff --git a/docs/zh-rTW/user/messages-and-channels.md b/docs/zh-rTW/user/messages-and-channels.md new file mode 100644 index 000000000..3b26e0732 --- /dev/null +++ b/docs/zh-rTW/user/messages-and-channels.md @@ -0,0 +1,159 @@ +--- +title: Messages & Channels +nav_order: 3 +last_updated: 2026-05-13 +description: Send and receive messages, manage channels, configure encryption, and use quick chat, reactions, and message actions. +aliases: + - 頻道 + - direct-messages + - messaging + - conversations +--- + +# Messages & Channels + +Meshtastic supports two communication modes: **channel broadcasts** and **direct messages**. + +## 頻道 + +Channels are shared communication groups. All nodes configured with the same channel key can read and send messages on that channel. + +### Default Channel + +Every Meshtastic device comes with a default **LongFast** channel. This is an unencrypted channel used for general mesh communication. + +### 頻道安全性 + +Channels support multiple encryption levels: + +| Icon | Security Level | 描述說明 | +| ---- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | +| 🔒 | PSK (256-bit AES) | Fully encrypted with a strong pre-shared key. Only nodes with the matching key can read messages. | +| 🔐 | PSK (128-bit AES) | Encrypted with a shorter key. Secure for most uses but 256-bit is preferred for sensitive data. | +| 🔓 | Default / Open | Uses the well-known default key. **Any Meshtastic device** on the same preset can read these messages. | +| ⚠️ | Insecure + Position | Open channel that also broadcasts your GPS position. Use with caution in public meshes. | + +> 🔒 **Security Tip:** Always configure a unique PSK for private communications. The default channel is intentionally open so new users can discover the mesh — but you should create a separate encrypted channel for anything sensitive. + +### Adding a Channel + +1. Navigate to **Settings → Channels**. +2. Tap **Add Channel** or scan a QR code. +3. Configure the channel name and encryption key. +4. Share the channel URL/QR code with others who need access. + +Tapping a channel shows its details and sharing options. + +## 私訊 + +Direct messages (DMs) are point-to-point encrypted communications between two specific nodes. + +### Sending a Direct Message + +1. Open the **Messages** tab. +2. Select a node from your contacts list or tap a node in the node list. +3. Type your message and tap **Send**. + +### Message States + +| State | Icon | Meaning | +| --------------------------------- | ---- | ----------------------------------------------------------------------------------------------------------------- | +| Queued | ⏳ | Message waiting to be sent | +| En route | ✓ | Delivered to the radio, awaiting acknowledgment | +| 已送達 | ✓✓ | Acknowledgment received from recipient | +| Received | ✓ | Message received from the mesh (incoming) | +| S&F Routing | 🔗 | Store & Forward: message being routed through an S&F node | +| S&F Confirmed | 🔗 | Store & Forward: delivery confirmed via S&F node | +| 錯誤 | ✗ | Delivery failed after retries | + +### Delivery Errors + +When a message fails to deliver, the error indicator shows what went wrong: + +| 錯誤 | Meaning | What to Do | +| ---------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| No Route | No path exists to the destination node | The recipient may be offline or out of mesh range. Try later or move closer. | +| Got NAK | The next-hop node refused to relay | The relay node may be congested. Wait and retry. | +| Timeout - 超時 | No acknowledgment within retry window | The recipient may be just out of range. Try increasing hop limit or moving to a better position. | +| 無介面 | No radio interface available to send | Check that your radio is connected and the channel is configured. | +| Max Retransmit | All retry attempts exhausted | The mesh path is unreliable. Try a different channel or wait for conditions to improve. | +| 無頻道 | The destination channel doesn't exist | Verify both nodes share the same channel configuration. | +| Too Large | Message exceeds maximum payload size | Shorten your message (max ~230 characters). | +| 無回應 | Node received message but didn't respond | The recipient's radio may be busy or in low-power sleep mode. | +| Duty Cycle Limit | Regional airtime limit reached | Your radio has used its allowed transmit time. Wait for the duty cycle window to reset (typically 1 hour in EU regions). | +| 錯誤請求 | Malformed or invalid message | This usually indicates a software bug. Try restarting the app. | + +> 💡 **Tip:** Most delivery errors resolve themselves. If a node is intermittently reachable, the mesh will retry. For persistent "No Route" errors, check that intermediate Router nodes are online. + +## Message Features + +### Quick Chat + +Pre-configured messages for rapid communication: + +- Access via the Quick Chat button in the message input area +- Choose from built-in phrases or custom messages +- Customize quick chat messages in **Settings → Quick Chat** +- Useful when typing is impractical (gloves, small screen, urgent) + +![Quick chat option](/assets/screenshots/messages_quick_chat.png) + +The channel list shows each channel with its latest message preview. + +### Message Bubbles + +Messages appear as chat bubbles — sent messages on the right, received messages on the left. Each bubble shows the sender, timestamp, and delivery status. Messages with replies include a quoted preview of the original message above the response. + +### Reactions + +React to messages with emoji: + +- **Long-press** a message to open the actions menu +- Tap **Add Reaction** to choose an emoji +- Reactions appear below the message bubble +- Multiple users can react to the same message +- React to your own messages or others' messages + +![Emoji reaction badges displayed beneath a message](/assets/screenshots/messages_reaction.png) + +> 💡 **Tip:** Reactions are lightweight — they use minimal mesh bandwidth compared to full text messages. + +### Message Actions + +Long-press any message to access: + +- **Copy** — copy message text to clipboard +- **Reply** — quote the message in your response +- **React** — add an emoji reaction +- **Delete** — remove a message you sent (local deletion) + +### Message Priority + +Messages are queued and transmitted based on priority: + +1. Emergency/alert messages (highest) +2. Direct messages +3. Channel broadcasts (lowest) + +### Message Limits + +- **Maximum length:** 237 bytes (approximately 230 characters for ASCII text) +- **Rate limiting:** The mesh enforces airtime fairness; heavy message volume may be throttled +- **Delivery:** Messages are retried automatically if no acknowledgment is received + +## 最佳實踐 + +- Use channels for group coordination +- Use direct messages for private person-to-person communication +- Keep messages short — mesh bandwidth is limited +- Configure encryption for sensitive communications + +## Related Topics + +- [Nodes](nodes) — tap a node to start a direct message +- [Settings — Radio & User](settings-radio-user) — configure channel encryption and presets +- [MQTT](mqtt) — bridge channel messages to the internet +- [Channel configuration](https://meshtastic.org/docs/configuration/radio/channels) — detailed channel settings on meshtastic.org + +--- + diff --git a/docs/zh-rTW/user/mqtt.md b/docs/zh-rTW/user/mqtt.md new file mode 100644 index 000000000..9395201ee --- /dev/null +++ b/docs/zh-rTW/user/mqtt.md @@ -0,0 +1,137 @@ +--- +title: MQTT +nav_order: 11 +last_updated: 2026-05-13 +description: Bridge your mesh to the internet — MQTT broker setup, encryption layers, and map reporting. +aliases: + - MQTT + - internet-bridge + - broker +--- + +# MQTT + +MQTT bridges your Meshtastic mesh network to the internet, enabling long-range communication beyond radio range. + +## 概觀 + +The MQTT module connects your node to an MQTT broker, allowing: + +- Messages to reach nodes on different physical meshes via the internet +- Integration with home automation and monitoring systems +- Publishing node positions to the public Meshtastic map +- Custom data pipelines for logging and alerting + +## 運作方式 + +``` +[Your Node] → Radio → [Gateway Node with WiFi] → MQTT Broker → [Remote Gateway] → Radio → [Remote Node] +``` + +A gateway node with internet access (WiFi or Ethernet) publishes mesh messages to an MQTT topic. Remote gateways subscribed to the same topic inject those messages into their local mesh. + +## 設定 + +### 啟用 MQTT + +1. Navigate to **Settings → Module Config → MQTT**. +2. Enable the MQTT module. +3. Configure the broker connection: + +![MQTT toggle switch](/assets/screenshots/settings_switch.png) + +| 設定 | 描述說明 | 默認 | +| --------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------- | +| 伺服器位址 | MQTT broker hostname | mqtt.meshtastic.org | +| 使用者名稱 | Broker authentication | meshdev | +| 密碼 | Broker authentication | large4cats | +| 根主題 | Base topic for messages | msh | +| 加密 | Encrypt MQTT payload | 已啟用 | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON packet support has been removed from firmware; this field is ignored | Disabled | +| TLS | Secure connection to broker | Disabled | +| Map Reporting | Report position to public map | Disabled | + +### Default Meshtastic Broker + +The community maintains a public broker at `mqtt.meshtastic.org`. This is intended for general use and testing. + +> 🔒 **Privacy:** Messages on the public broker are readable by anyone subscribed. Always use channel encryption for private communications. + +### Private Broker + +For better privacy and control, you can run your own MQTT broker: + +- Mosquitto (lightweight, open-source) +- HiveMQ +- EMQX + +Configure your node to point to your private broker with appropriate credentials. + +## Map Reporting + +When Map Reporting is enabled, your node publishes its position to the Meshtastic community map: + +- Visible at [meshmap.net](https://meshmap.net) and similar community map services +- Only position and node info are shared +- Disable this if you don't want your location publicly visible + +## Uplink vs Downlink + +| Direction | 描述說明 | +| ------------ | -------------------------------- | +| **Uplink** | Messages from mesh → MQTT broker | +| **Downlink** | Messages from MQTT broker → mesh | + +Configure per-channel which directions are active to control message flow and airtime usage. + +## Message Formats + +MQTT uses protobuf message format: + +| Format | 描述說明 | Use case | +| ------------ | ----------------------------------- | -------------------------- | +| **Protobuf** | Binary Meshtastic protobuf encoding | Node-to-node mesh bridging | + +> ⚠️ **Note:** JSON output support was removed from firmware. The `json_enabled` setting is still visible in the app for legacy compatibility but has no effect on current firmware versions. + +## Encryption & Privacy + +Understanding the layered encryption model: + +1. **Channel encryption** happens on the mesh _before_ MQTT. If your channel has a PSK, the MQTT payload is already encrypted — the broker and any subscribers see only the ciphertext. +2. **MQTT encryption** (the module setting) adds an additional encryption layer for transit to the broker. This protects metadata and routing information. +3. **TLS** encrypts the TCP connection to the broker itself, preventing network-level eavesdropping. + +> 🔒 **Important:** The default public channel has a well-known key. Messages on the default channel sent via MQTT are effectively **unencrypted** — anyone can decode them. Always use a custom PSK for private communications. + +## 最佳實踐 + +- Use channel-level encryption (PSK) on channels that bridge to MQTT +- Don't enable MQTT on nodes without internet access (it will buffer and waste memory) +- Use a private broker for sensitive deployments +- Be mindful of airtime when downlinking messages from busy MQTT topics — every downlinked message consumes radio airtime on your local mesh +- Consider enabling uplink-only if you only need to monitor your mesh remotely without injecting messages back + +## 故障排除 + +### MQTT Not Connecting + +- **Check WiFi** — the gateway node must have an active internet connection (WiFi or Ethernet). MQTT does not work over the LoRa radio link itself. +- **Verify credentials** — incorrect username or password will silently fail on most brokers. Double-check for trailing spaces. +- **Firewall** — port 1883 (MQTT) or 8883 (MQTT+TLS) must be open. Some networks block non-standard ports. +- **DNS resolution** — if using a custom broker hostname, verify the node can resolve it. Try the broker's IP address directly. + +### Messages Not Bridging + +- **Check uplink/downlink settings** — if only uplink is enabled, messages flow from mesh to MQTT but not back. Enable downlink on the receiving gateway. +- **Channel mismatch** — both gateways must share the same channel with the same PSK. A mismatch means messages are encrypted with different keys and appear as garbage. +- **Topic mismatch** — ensure both gateways use the same root topic. The default `msh` works for the public broker. + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — MQTT module configuration reference +- [Messages & Channels](messages-and-channels) — channel encryption and PSK setup +- [MQTT integration guide](https://meshtastic.org/docs/software/integrations/mqtt) — detailed MQTT documentation on meshtastic.org + +--- + diff --git a/docs/zh-rTW/user/node-metrics.md b/docs/zh-rTW/user/node-metrics.md new file mode 100644 index 000000000..e0c57ca84 --- /dev/null +++ b/docs/zh-rTW/user/node-metrics.md @@ -0,0 +1,130 @@ +--- +title: Node Metrics +nav_order: 5 +last_updated: 2026-05-13 +description: Telemetry dashboards for each mesh node — device health, environment sensors, signal quality, power, traceroute, and position history. +aliases: + - metrics + - 遙測 + - device-metrics + - signal +--- + +# Node Metrics + +The node detail screen provides comprehensive telemetry and metrics for each node on your mesh. + +## 裝置計量資料 + +Basic operating information reported by each node: + +| 公制（公里/公尺） | 描述說明 | +| ------------- | ----------------------------------- | +| Battery Level | Current battery percentage | +| 電壓 | Battery voltage reading | +| 頻道使用量 | Percentage of airtime consumed | +| Airtime | Transmission time used by this node | +| 運行時間 | Time since last reboot | + +Device metrics are displayed as individual cards with trend sparklines showing battery level, voltage, channel utilization, airtime, and uptime over time. + +> 💡 **Tip:** Tap any metric card to expand it into a full chart with historical data points. Pinch to zoom the time axis. + +## 環境計量資料 + +Environmental sensor data (requires compatible hardware): + +| 公制（公里/公尺） | Sensor Examples | +| ------------------------------------ | --------------------- | +| 溫度 | BME280, BME680, SHT31 | +| 濕度 | BME280, BME680, SHT31 | +| 大氣壓力 | BME280, BMP280 | +| 氣體感測器 | BME680 | +| IAQ (Air Quality) | BME680 | + +Environment metrics are charted over time for easy trend analysis — temperature, humidity, and pressure each get their own line chart with the measurement unit displayed on the Y axis. + +> 💡 **Tip:** Environment metrics require a sensor connected to the remote node. Not all nodes report environmental data. See [Telemetry & Sensors](telemetry-and-sensors) for a full list of supported sensors. + +## Signal Metrics + +Radio signal quality information: + +| 公制（公里/公尺） | 描述說明 | +| --------- | ----------------------------------------------------------------------------- | +| SNR | Signal-to-Noise Ratio (higher is better) | +| RSSI | Received Signal Strength Indicator (closer to 0 is better) | +| 跳躍次數 | Number of mesh hops for last message | + +### Signal Quality Reference + +| SNR Range | Quality | +| --------------------------------- | --------- | +| > 10 dB | Excellent | +| 0 to 10 dB | 良好 | +| -10 to 0 dB | 普通 | +| < -10 dB | Poor | + +## 電源計量資料 + +Power management telemetry (requires INA sensor or compatible hardware): + +| 公制（公里/公尺） | 描述說明 | +| ----------- | ----------------------- | +| Bus Voltage | Supply voltage | +| 目前 | Power draw in milliamps | +| 電力 | Calculated wattage | + +## 路由追蹤 + +Traceroute shows the path a message takes through the mesh: + +1. From the node detail screen, tap **Traceroute**. +2. The app sends a traceroute request to the target node. +3. Results show each hop with SNR/RSSI values. + +### Reading Traceroute Results + +``` +You → Node A (SNR: 8.5) → Node B (SNR: 5.2) → Target +``` + +Each hop represents a relay node that forwarded the message. + +## 定位日誌 + +Historical position data for nodes that share their location: + +- GPS coordinates +- 海拔高度 +- Speed (if moving) +- Timestamp for each position report + +## 鄰近節點資訊 + +Shows which nodes a given node can directly hear, useful for understanding mesh topology. + +## Viewing Metrics + +1. Navigate to **Nodes**. +2. Tap the node you want to inspect. +3. Select the metric category from the detail tabs. + +![Node detail — local device](/assets/screenshots/nodes_detail_local.png) + +The position tab shows location data for nodes that share GPS: + +![Position inline content](/assets/screenshots/nodes_position.png) + +> ⚠️ **Note:** Metrics are only available when they have been reported by the remote node. Metrics update at intervals configured on each node's telemetry settings. + +## Related Topics + +- [Nodes](nodes) — node list, filtering, and sorting +- [Telemetry & Sensors](telemetry-and-sensors) — supported sensors and configuration +- [Signal Meter](signal-meter) — how signal quality is calculated from SNR and RSSI +- [Discovery](discovery) — traceroute details and neighbor info +- [Units & Locale](units-and-locale) — temperature, distance, and speed display formats + +--- + diff --git a/docs/zh-rTW/user/nodes.md b/docs/zh-rTW/user/nodes.md new file mode 100644 index 000000000..bc8f095cb --- /dev/null +++ b/docs/zh-rTW/user/nodes.md @@ -0,0 +1,152 @@ +--- +title: 節點 +nav_order: 4 +last_updated: 2026-05-13 +description: Browse, filter, and sort mesh nodes — view details, signal quality, roles, and quick actions. +aliases: + - node-list + - mesh-nodes + - peers +--- + +# 節點 + +The Nodes screen displays all devices visible on your mesh network. + +## Node List + +The node list shows every node your radio has heard, including: + +- **Node name** — user-configured long name +- **Short name** — 4-character identifier +- **Signal quality** — last heard signal strength +- **Last heard** — time since last communication +- **Distance** — estimated distance (if positions are shared) +- **Battery** — remote node battery level (if telemetry is enabled) + +### Node Status Indicators + +| Badge | Meaning | +| ---------- | ------------------------------------- | +| 🟢 Online | Node heard within the last 15 minutes | +| 🟡 Away | Node heard within the last 2 hours | +| 🔴 Offline | Node not heard for over 2 hours | +| ⭐ Favorite | Node marked as favorite by the user | + +### Node Roles + +Nodes can be configured with different roles that affect their mesh behavior: + +| 角色 | 描述說明 | +| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | +| 用戶端 | Standard end-user device | +| 客戶端基礎模式 | Treats favorited-node traffic as Router Late priority; all other traffic as Client | +| Client Mute | Receives but doesn't retransmit | +| Client Hidden | Like Client Mute, plus hides from node list | +| Router | Prioritizes message forwarding; stays awake to relay | +| Router Late | Infrastructure node that rebroadcasts once, but only after all other modes (provides supplemental coverage) | +| ~~Router Client~~ | ⚠️ **Deprecated** (removed in firmware 2.3.15) — no longer selectable; use Router or Client instead | +| ~~Repeater~~ | ⚠️ **Deprecated** (removed in firmware 2.7.11) — no longer selectable; use Router instead | +| Repeater | Optimized for position reporting at regular intervals | +| 感測器 | Optimized for telemetry reporting | +| TAK | Interoperates with TAK systems (sends/receives CoT) | +| TAK Tracker | TAK position reporting only | +| Lost & Found | Continuous position beacon for recovery | + +### Choosing a Role + +Most users should keep the default **Client** role. Consider a different role when: + +- **Router** — You have a node in a fixed, elevated location with reliable power (rooftop, hilltop). Routers stay awake continuously to relay messages for others and are essential for extending mesh coverage. Don't use Router on battery-powered handheld devices. +- **Router Late** — An infrastructure node that always rebroadcasts packets once but only after all other routing modes have had their turn. Provides supplemental coverage for local clusters without competing with primary routers. +- **Client Base** — Treats traffic from/to your favorited nodes with Router Late priority (ensuring those messages get extra relay coverage) while handling everything else as a normal Client. +- **Client Mute** — You want to receive mesh traffic but not contribute to relaying. Useful for monitoring-only devices or to reduce congestion in dense areas. +- **Tracker** — An unattended device whose sole purpose is broadcasting its GPS position (e.g., a vehicle, pet, or asset). Sleeps between broadcasts to conserve battery. +- **Sensor** — An unattended device reporting environmental telemetry (temperature, humidity, air quality). Similar power profile to Tracker. +- **TAK / TAK Tracker** — Only needed if interoperating with ATAK/WinTAK systems. See [TAK Integration](tak) for details. + +> 💡 **Tip:** The mesh works best when most nodes are **Client** or **Router**. Too many Mute nodes reduces mesh resilience; too many Routers in a dense area can cause congestion. A good rule of thumb: one Router per 5–10 Clients in your area. + +### Encryption Indicators + +Nodes display encryption status icons next to their name: + +| Icon | Meaning | +| ----------- | ------------------------------------------------------------------------------------------------------------------- | +| 🔒 Locked | Communication uses PKI (public key infrastructure) — end-to-end encrypted with verified identity | +| 🔓 Unlocked | Communication uses shared channel PSK — encrypted but identity not individually verified | +| ⚠️ Mismatch | Public key mismatch — the node's key has changed since last seen (investigate before trusting) | + +> 💡 **Tip:** PKI encryption (firmware 2.5+) provides stronger security than channel PSK because each node has a unique key pair. If you see a key mismatch warning, the node may have been reset or compromised. + +## Quick Actions + +From the node list, you can: + +- **Tap** a node to view its detail page +- **Long-press** for quick actions: + - Send a direct message + - 在地圖上檢視 + - 要求位置 + - Mark as favorite + - 路由追蹤 + +## Filtering & Sorting + +### Text Search + +Type in the search field to filter nodes by name or short name. The filter updates in real time as you type. + +### Filter Toggles + +| 過濾器 | 描述說明 | +| -------------------------- | ---------------------------------------------------------------------------------------------- | +| **Only online** | Show only nodes heard within the last 15 minutes | +| **Only direct** | Show only nodes with direct (non-relayed) connections | +| **Include unknown** | Show nodes that haven't sent user info yet | +| **Exclude infrastructure** | Hide infrastructure-role nodes (Router, Repeater, Router Late, Client Base) | +| **Exclude MQTT** | Hide nodes heard only via MQTT internet bridge | +| **Show ignored** | Show nodes you've previously dismissed or muted | + +### Sort Options + +| Sort | 描述說明 | +| ------------------------------------------- | ------------------------------------------------------------------ | +| **Last heard** (default) | Most recently heard nodes first | +| **Alphabetical** | Sorted by node long name | +| **Distance** | Nearest nodes first (requires position sharing) | +| **Hops away** | Fewest relay hops first | +| **Channel** | Grouped by channel index | +| **Via MQTT** | Grouped by MQTT vs. radio-heard | +| **Favorites** | Favorited nodes first | + +## Node Detail + +Tapping a node opens the detail view with comprehensive information. See [Node Metrics](node-metrics) for full details on metrics and telemetry. + +![Node detail view](/assets/screenshots/nodes_node_list.png) + +The detail screen includes device info, position, and action buttons: + +![Node detail section](/assets/screenshots/nodes_detail_section.png) + +Inline status indicators show key metrics at a glance: + +| Indicator | 螢幕截圖 | +| -------------- | -------------------------------------------------------- | +| Signal quality | ![Signal](/assets/screenshots/nodes_signal_info.png) | +| 電池電量 | ![Battery](/assets/screenshots/nodes_battery_info.png) | +| Hop count | ![Hops](/assets/screenshots/nodes_hops_info.png) | +| 最近一次收到排序 | ![Last heard](/assets/screenshots/nodes_last_heard.png) | +| 距離 | ![Distance](/assets/screenshots/nodes_distance_info.png) | + +## Related Topics + +- [Node Metrics](node-metrics) — detailed telemetry dashboards for each node +- [Messages & Channels](messages-and-channels) — send a direct message to a node +- [Map & Waypoints](map-and-waypoints) — view node positions geographically +- [Discovery](discovery) — traceroute and neighbor info for topology exploration +- [Signal Meter](signal-meter) — understand what the signal bars mean + +--- + diff --git a/docs/zh-rTW/user/onboarding.md b/docs/zh-rTW/user/onboarding.md new file mode 100644 index 000000000..69d93ed9d --- /dev/null +++ b/docs/zh-rTW/user/onboarding.md @@ -0,0 +1,237 @@ +--- +title: 新手入門 +nav_order: |- + 1. **Overview** + + Meshtastic is a project that allows you to use inexpensive LoRa radios as a long range, off-grid, decentralized communication platform. These radios, combined with readily available and very affordable microcontrollers like the ESP32, nRF52, and RP2040, create a network that can be used to send text messages, share locations, and more without relying on cellular or WiFi infrastructure. It's perfect for hiking, camping, or any situation where you need to stay connected beyond the reach of traditional networks. + + 2. **Key Components** + + * **LoRa Radios:** These radios provide the long-range communication capabilities. The RAK Wireless modules are a popular choice. + * **Microcontrollers:** The brains of the operation. ESP32, nRF52, and RP2040 are commonly used due to their low cost and capabilities. + * **GPS (Optional):** For location sharing. Many devices, like the T-Beam, have built-in GPS. + * **Battery (Optional):** For portable use. + * **Enclosure (Optional):** To protect the hardware. + + 3. **Popular Devices** + + * **T-Beam:** A popular board with ESP32, LoRa, and GPS. + * **Heltec WiFi LoRa 32:** Another popular ESP32-based board with LoRa. + * **LilyGo Boards:** LilyGo offers a variety of ESP32 and nRF52 based boards with LoRa. + + 4. **Features** + + * **Text Messaging:** Send and receive text messages over the LoRa network. + * **Location Sharing:** Share your location with other users on the network (requires GPS). + * **Encryption:** Messages can be encrypted for privacy. + * **Mesh Networking:** The network automatically routes messages through other nodes to reach the destination. + * **Off-Grid Communication:** No cellular or WiFi required. + * **Channel Settings:** Customize channel settings for different regions and use cases (Long Fast, Mid Slow, etc.). + + 5. **Software & Firmware** + + * **Meshtastic Firmware:** The core software that runs on the microcontrollers. + * **Meshtastic Mobile App:** For configuring and interacting with the devices. Available on Android and iOS. + * **CLI (Command Line Interface):** For advanced configuration and debugging. + * **API (Application Programming Interface):** For integrating Meshtastic with other applications. + + 6. **Hardware Setup** + + * **Flashing Firmware:** You'll need to flash the Meshtastic firmware onto your microcontroller. This is typically done using a USB connection and a flashing tool. + * **Connecting Peripherals:** Connect the LoRa radio and any other peripherals (GPS, battery) to the microcontroller. + * **Antenna:** Attach an appropriate antenna to the LoRa radio. + + 7. **Configuration** + + * **Region Settings:** Configure the correct region settings for your location. + * **Channel Settings:** Choose a channel or create a custom channel. + * **Encryption:** Enable encryption for secure communication. + * **Power Settings:** Adjust power settings to optimize battery life. + + 8. **Technical Details** + + * **LoRa Modulation:** Uses LoRa modulation for long-range communication. + * **Frequency Bands:** Operates on various frequency bands depending on the region (e.g., 915 MHz in North America, 868 MHz in Europe). + * **Microcontroller Interfaces:** Uses various interfaces for communication between the microcontroller and peripherals, including GPIO, USB, UART, SPI, and I2C. + * **BLE (Bluetooth Low Energy):** Used for initial configuration and communication with the mobile app. + * **WiFi:** Some devices support WiFi for OTA (Over-The-Air) firmware updates. + * **MQTT:** Supports MQTT for integration with other systems. + + 9. **Use Cases** + + * **Hiking and Camping:** Stay connected with your group in areas without cellular coverage. + * **Emergency Communication:** Provide a backup communication system in case of emergencies. + * **Disaster Relief:** Establish communication networks in areas affected by disasters. + * **Rural Communication:** Connect communities in remote areas. + * **IoT Applications:** Use Meshtastic for various IoT applications that require long-range communication. + + 10. **Resources** + + * **Meshtastic Website:** [https://meshtastic.org/](https://meshtastic.org/) + * **Meshtastic Documentation:** [https://meshtastic.org/docs/](https://meshtastic.org/docs/) + * **Meshtastic Forums:** [https://meshtastic.discourse.group/](https://meshtastic.discourse.group/) + 1. **概觀** + + Meshtastic 是一個專案，讓你可以使用便宜的 LoRa 無線電作為長距離、離線、去中心化的通訊平台。這些無線電，結合了容易取得且非常實惠的微控制器，像是 ESP32、nRF52 和 RP2040，創建了一個網路，可以用來傳送簡訊、分享位置等等，而不需要依賴行動網路或 WiFi 基礎設施。它非常適合健行、露營，或任何你需要保持連線，但又超出傳統網路覆蓋範圍的情況。 + + 2. **主要組件** + + * **LoRa 無線電:** 提供長距離通訊能力。 RAK Wireless 模組是一個很受歡迎的選擇。 + * **微控制器:** 運作的大腦。 ESP32、nRF52 和 RP2040 因為它們的低成本和功能而被廣泛使用。 + * **GPS (可選):** 用於位置分享。 許多裝置，像是 T-Beam，都有內建 GPS。 + * **電池 (可選):** 用於攜帶型使用。 + * **外殼 (可選):** 保護硬體。 + + 3. **熱門裝置** + + * **T-Beam:** 一個受歡迎的板子，具有 ESP32、LoRa 和 GPS。 + * **Heltec WiFi LoRa 32:** 另一個受歡迎的基於 ESP32 的板子，具有 LoRa。 + * **LilyGo Boards:** LilyGo 提供各種基於 ESP32 和 nRF52 的板子，具有 LoRa。 + + 4. **功能** + + * **簡訊傳輸:** 透過 LoRa 網路傳送和接收簡訊。 + * **位置分享:** 與網路上其他使用者分享你的位置 (需要 GPS)。 + * **加密:** 可以加密訊息以保護隱私。 + * **網狀網路:** 網路會自動透過其他節點路由訊息，以到達目的地。 + * **離線通訊:** 不需要行動網路或 WiFi。 + * **頻道設定:** 客製化不同地區和使用案例的頻道設定 (Long Fast、Mid Slow 等)。 + + 5. **軟體與 Firmware** + + * **Meshtastic Firmware:** 在微控制器上執行的核心軟體。 + * **Meshtastic Mobile App:** 用於配置和與裝置互動。 可在 Android 和 iOS 上使用。 + * **CLI (Command Line Interface):** 用於進階配置和除錯。 + * **API (Application Programming Interface):** 用於將 Meshtastic 與其他應用程式整合。 + + 6. **硬體設定** + + * **刷入 Firmware:** 你需要將 Meshtastic firmware 刷入你的微控制器。 這通常是使用 USB 連線和刷入工具來完成的。 + * **連接週邊設備:** 將 LoRa 無線電和任何其他週邊設備 (GPS、電池) 連接到微控制器。 + * **天線:** 將適當的天線連接到 LoRa 無線電。 + + 7. **配置** + + * **區域設定:** 為你的位置配置正確的區域設定。 + * **頻道設定:** 選擇一個頻道或創建一個自定義頻道。 + * **加密:** 啟用加密以進行安全通訊。 + * **電源設定:** 調整電源設定以優化電池壽命。 + + 8. **技術細節** + + * **LoRa 調變:** 使用 LoRa 調變進行長距離通訊。 + * **頻率範圍:** 根據地區在不同的頻率範圍上運作 (例如，北美為 915 MHz，歐洲為 868 MHz)。 + * **微控制器介面:** 使用各種介面在微控制器和週邊設備之間進行通訊，包括 GPIO、USB、UART、SPI 和 I2C。 + * **BLE (Bluetooth Low Energy):** 用於初始配置和與行動應用程式的通訊。 + * **WiFi:** 某些裝置支援 WiFi 用於 OTA (Over-The-Air) firmware 更新。 + * **MQTT:** 支援 MQTT 用於與其他系統整合。 + + 9. **使用案例** + + * **健行和露營:** 在沒有行動網路覆蓋的地區與你的團隊保持聯繫。 + * **緊急通訊:** 在緊急情況下提供備份通訊系統。 + * **災害救援:** 在受災害影響的地區建立通訊網路。 + * **農村通訊:** 連接偏遠地區的社群。 + * **IoT 應用:** 將 Meshtastic 用於各種需要長距離通訊的 IoT 應用。 + + 10. **資源** + + * **Meshtastic Website:** [https://meshtastic.org/](https://meshtastic.org/) + * **Meshtastic Documentation:** [https://meshtastic.org/docs/](https://meshtastic.org/docs/) + * **Meshtastic Forums:** [https://meshtastic.discourse.group/](https://meshtastic.discourse.group/) +last_updated: 2026-05-13 +description: First-launch setup — permissions, onboarding flow, and next steps after connecting your radio. +aliases: + - first-launch + - setup + - intro +--- + +# # 入門指南 + +Welcome to Meshtastic! This guide walks you through the initial setup of the Meshtastic Android app. + +## First Launch + +When you open the app for the first time, you'll be guided through an introductory flow that helps configure essential permissions and settings. Each step can be completed in order, or you can skip and configure permissions later in Android settings. + +### Welcome Screen + +The welcome screen introduces Meshtastic and its core capabilities: + +- Off-grid mesh communication +- No cellular or internet required +- End-to-end encrypted messaging + +Tap **Get Started** to proceed through the setup flow. + +![Welcome screen](/assets/screenshots/onboarding_welcome.png) + +## Permissions + +The app requests several permissions during setup. Each one serves a specific purpose, and some are required for core functionality. + +### Bluetooth Permission + +Bluetooth is the primary connection method between your phone and Meshtastic radio: + +- **Bluetooth scanning** — discover nearby Meshtastic radios +- **Bluetooth connect** — establish and maintain connections with paired radios + +Grant both permissions when prompted. Without Bluetooth, you'll need to use USB or TCP connections instead. + +### Location Permission + +> ⚠️ **Why is location required for Bluetooth?** Android requires location permission to discover nearby Bluetooth Low Energy devices. This is an Android system requirement, not a Meshtastic-specific choice. + +Meshtastic also uses your location for: + +- Showing your position on the mesh map +- Calculating distances to other nodes +- Sharing your GPS coordinates with other mesh members (if enabled) + +Grant **"While using the app"** or **"Always"** depending on your preference: + +- **While using the app** — position updates only when the app is open +- **Always** — enables background position updates for always-on mesh presence + +If denied, Bluetooth scanning will not function and your node will not report a position. + +### Notifications Permission + +Notifications alert you to: + +- Incoming messages from channels and direct messages +- Connection status changes (connected, disconnected, reconnecting) +- Firmware update availability + +> 💡 **Tip:** You can fine-tune notification preferences later in Android system settings. The app creates separate notification channels for messages, connection events, and background service status. + +### Critical Alerts Permission + +On supported devices, the app may request permission for critical alerts: + +- These are high-priority notifications that can break through Do Not Disturb mode +- Useful for emergency mesh alerts or urgent messages +- You can **skip** this step if you don't need breakthrough notifications +- Configure or revoke later in Android notification settings + +## After Setup + +Once permissions are granted, the app transitions to the main interface. Your first action should be connecting to a Meshtastic radio — see [Connections](connections) for detailed instructions. + +> 💡 **Tip:** If you skipped any permissions during setup, you can grant them later through **Android Settings → Apps → Meshtastic → Permissions**. The app will prompt you again if a missing permission blocks a feature you try to use. + +## What's Next? + +Once connected to a radio, explore: + +- [Connections](connections) — pair your first radio device +- [Messages & Channels](messages-and-channels) — send your first message +- [Nodes](nodes) — see who's on your mesh +- [Map & Waypoints](map-and-waypoints) — view node positions +- [Settings](settings-radio-user) — configure your radio and user profile + +New to Meshtastic? The [getting started guide](https://meshtastic.org/docs/getting-started) on meshtastic.org covers hardware selection, initial radio configuration, and your first mesh setup. + +--- diff --git a/docs/zh-rTW/user/settings-module-admin.md b/docs/zh-rTW/user/settings-module-admin.md new file mode 100644 index 000000000..5ceb802e6 --- /dev/null +++ b/docs/zh-rTW/user/settings-module-admin.md @@ -0,0 +1,246 @@ +--- +title: Settings — Modules & Admin +nav_order: 8 +last_updated: 2026-05-13 +description: Configure optional feature modules (MQTT, telemetry, canned messages, TAK, and more) and perform device administration. +aliases: + - modules + - 模組設定 + - administration +--- + +# Settings — Modules & Admin + +Configure optional feature modules and perform device administration. Modules extend Meshtastic with specialized capabilities — each can be independently enabled or disabled. + +> 💡 **Tip:** You only need to enable the modules you actually use. Disabling unused modules reduces airtime, saves battery, and simplifies your configuration. + +Module settings use a card-based layout with toggle switches, dropdowns, text fields, and sliders: + +![Toggle switch](/assets/screenshots/settings_switch.png) + +![Dropdown selector](/assets/screenshots/settings_dropdown.png) + +![Text field](/assets/screenshots/settings_text_field.png) + +![Settings card layout](/assets/screenshots/settings_titled_card.png) + +## 模組設定 + +### MQTT Module + +Bridges mesh messages to and from an MQTT broker for internet connectivity. This is how you extend your mesh beyond radio range or integrate with home automation systems. + +| 設定 | 描述說明 | +| --------------- | ------------------------------------------------------------------------ | +| 已啟用 | Toggle MQTT bridge | +| 伺服器 | MQTT broker address | +| 使用者名稱 | Authentication username | +| 密碼 | Authentication password | +| 加密 | Encrypt MQTT payloads | +| ~~JSON Output~~ | ⚠️ **Deprecated** — JSON support removed from firmware; field is ignored | +| TLS | Use secure connection | +| 根主題 | Base MQTT topic path | +| Map Report | Publish position for public map | + +See [MQTT](mqtt) for a detailed usage guide including encryption, privacy, and broker setup. + +### Serial Module + +Enables serial port communication for external device integrations (GPS modules, sensors, or custom hardware). When enabled, the node's serial port can send and receive protobuf or text data, allowing external microcontrollers or computers to interact with the mesh. + +| 設定 | 描述說明 | +| ---------- | ------------------------------- | +| 已啟用 | Activate serial communication | +| Echo | Echo received serial data back | +| 模式 | Text, Protobuf, or NMEA output | +| RX/TX Pins | GPIO pins for serial connection | +| 鮑率 | Serial communication speed | + +### External Notification Module + +Controls buzzer, LED, or vibration alerts on your radio hardware. Useful for devices that need to physically signal when a message arrives — particularly helpful for unattended or outdoor installations. + +| 設定 | 描述說明 | +| -------------------------------- | --------------------------- | +| 已啟用 | Activate notifications | +| Alert Message | Notify on incoming messages | +| Alert Message Buzzer | Use buzzer for messages | +| Alert Message Vibra | Use vibration for messages | +| Alert Bell | Notify on bell character | +| Output (GPIO) | Pin for notification output | +| Active | High or Low active | +| Duration (ms) | Notification length | +| Use I2S as Buzzer | Use I2S audio output | + +### Store & Forward Module + +Buffers messages for nodes that were temporarily offline, then replays them when those nodes reconnect. Essential for meshes where nodes go in and out of range regularly — ensures messages aren't lost during brief disconnections. + +| 設定 | 描述說明 | +| ------------------------------------------ | -------------------------- | +| 已啟用 | Activate store and forward | +| Heartbeat (s) | Announcement interval | +| 紀錄 | Maximum stored messages | +| History Return (max) | Max messages to replay | +| History Return (window) | Time window for replay | + +> 💡 **Tip:** Store and Forward works best on nodes with ample memory (ESP32 with PSRAM). Router nodes are ideal candidates since they're typically always-on. + +### Range Test Module + +Automated range testing tool for evaluating link quality between nodes. When enabled, the node periodically transmits test messages with incrementing counters. A receiver node logs these messages, allowing you to walk or drive away and later analyze at what distance messages stopped arriving. + +| 設定 | 描述說明 | +| -------------------------------------- | --------------------------------- | +| 已啟用 | Activate range testing | +| Sender Interval (s) | Time between test transmissions | +| Save CSV | Log received test data to SD card | + +### Telemetry Module + +Controls what telemetry data your node shares with the mesh. Telemetry includes device health (battery, uptime) and environmental sensor data (temperature, humidity, pressure). + +| 設定 | 描述說明 | +| ---------------------------- | --------------------------------------- | +| Device Metrics Interval | How often to report device metrics | +| Environment Metrics Interval | How often to report environment sensors | +| 空氣品質已啟用 | Report particulate sensor data | +| 已啟用電源量測指標 | Report power usage | + +See [Telemetry & Sensors](telemetry-and-sensors) for supported sensors and configuration recommendations. + +### Canned Message Module + +Pre-configured messages accessible from the device's physical buttons (for radios with rotary encoders, keypads, or similar input hardware). Define a list of quick-send messages that can be transmitted without a phone connected — ideal for field use. + +| 設定 | 描述說明 | +| ------------------ | ----------------------------------------------------------- | +| ~~Enabled~~ | ⚠️ **Deprecated** — current firmware may ignore this toggle | +| 訊息 | Newline-separated list of messages | +| 傳送 Bell | Play bell sound on send | +| Rotary Encoder | Enable rotary encoder input | +| Up/Down/Press Pins | GPIO pin assignments for input | + +### Audio Module + +Codec2 audio support for low-bandwidth voice communication over the mesh. This is an **experimental** feature that encodes voice into very small data packets using the Codec2 codec. + +| 設定 | 描述說明 | +| ------------ | -------------------------------- | +| 已啟用 | Activate audio module | +| Codec2 Rate | Audio quality/bandwidth tradeoff | +| I2S 字元選擇 | GPIO pin for I2S WS | +| I2S Data In | GPIO pin for I2S DIN | +| I2S Data Out | GPIO pin for I2S DOUT | + +> ⚠️ **Note:** Audio requires specific hardware (I2S microphone and speaker). Voice quality is very low-bandwidth — think "understandable radio voice," not phone-call quality. + +### Remote Hardware Module + +GPIO control over the mesh network. Allows a remote node to read or write GPIO pins on another node — useful for activating relays, reading switches, or controlling external hardware from a distance. + +| 設定 | 描述說明 | +| -------------------- | --------------------------------------------------------------- | +| 已啟用 | Activate remote GPIO access | +| Allow Undefined Pins | Allow access to any GPIO pin (security risk) | + +> ⚠️ **Warning:** Enabling "Allow Undefined Pins" gives remote nodes access to all GPIO pins, which could interfere with the radio's own hardware. Only enable on dedicated GPIO nodes. + +### Neighbor Info Module + +Broadcasts information about directly heard neighbors, enabling mesh topology mapping. Each enabled node periodically shares a list of the other nodes it can hear and their signal quality. + +| 設定 | 描述說明 | +| -------------------------------------- | ------------------------------------ | +| 已啟用 | Activate neighbor broadcasting | +| Update Interval (s) | How often to broadcast neighbor list | + +See [Discovery](discovery) for how to use neighbor data for mesh topology exploration. + +### Ambient Lighting Module + +Controls onboard NeoPixel or other addressable RGB LEDs on supported hardware. Can be used for visual status indicators, notification lights, or decorative effects. + +| 設定 | 描述說明 | +| ------------------ | ---------------------------------------------------------- | +| 已啟用 | Activate LED control | +| LED 狀態 | On, Off, or set specific color | +| Red / Green / Blue | Individual color channel values (0–255) | + +### Detection Sensor Module + +Turns your node into a motion or door sensor alert system. When a GPIO pin detects a state change (motion detected, door opened), the node broadcasts an alert message over the mesh. + +| 設定 | 描述說明 | +| ---------------------------------------- | ----------------------------------------------------------------------- | +| 已啟用 | Activate detection sensor | +| 監控腳位 | GPIO pin connected to sensor | +| 偵測觸發高電位 | Trigger when pin goes high (vs. low) | +| Minimum Broadcast (s) | Minimum time between alert broadcasts | +| State Broadcast (s) | Periodic state broadcast interval | +| 傳送 Bell | Include bell character in alerts | +| 友善名稱 | Custom name for this sensor | + +### Paxcounter Module + +People counter using WiFi and BLE probe requests. Counts nearby devices by passively listening for probe requests that phones and laptops emit when scanning for networks. Available only on ESP32 devices. + +| Setting 設定 | 描述說明 | +| -------------------------------------- | -------------------------- | +| 已啟用 | Activate people counting | +| Update Interval (s) | How often to report counts | + +> 💡 **Tip:** Paxcounter is useful for estimating foot traffic at trailheads, event venues, or other locations. Counts are approximate — one person may carry multiple devices. + +### TAK Module + +Team Awareness Kit integration for interoperability with ATAK and WinTAK. See [TAK Integration](tak) for detailed setup and usage. + +## 管理 + +### 遠端管理 + +Remotely configure nodes that share your admin key: + +1. Select the target node in the node list. +2. Navigate to **Settings** for that node. +3. Modify configuration. +4. Tap **Save** — changes are sent over the mesh. + +> ⚠️ **Requires:** Admin key configured on both your node and the target node. + +### 清除節點資料庫 + +Removes stale nodes from your local database that haven't been heard in a configurable time window. + +### 恢復原廠設定 + +Resets all settings to factory defaults. **This cannot be undone.** + +### 重新開機 + +Remotely reboot a connected or administered node. + +### 偵錯面板 + +View detailed diagnostic information: + +- Protocol buffers debug output +- Mesh packet log +- Connection state details + +### Troubleshooting Remote Admin + +- **"No response from target node"** — the target may be out of range, offline, or have a mismatched admin key. Verify the admin key matches on both nodes. +- **Changes not applying** — some settings require a reboot to take effect. Try the Reboot action after saving. +- **Can't see remote settings** — ensure your node has the admin key for the target node and that Admin Channel is enabled in Security Config. + +## Related Topics + +- [Settings — Radio & User](settings-radio-user) — core radio and user profile settings +- [Module configuration reference](https://meshtastic.org/docs/configuration/module) — detailed module docs on meshtastic.org +- [FAQ](https://meshtastic.org/docs/about/faq) — common questions on meshtastic.org + +--- + diff --git a/docs/zh-rTW/user/settings-radio-user.md b/docs/zh-rTW/user/settings-radio-user.md new file mode 100644 index 000000000..a53676730 --- /dev/null +++ b/docs/zh-rTW/user/settings-radio-user.md @@ -0,0 +1,173 @@ +--- +title: Settings — Radio & User +nav_order: 7 +last_updated: 2026-05-13 +description: Configure your radio hardware, LoRa presets, user profile, position sharing, power management, and security. +aliases: + - 設定 + - radio-config + - user-config + - LoRa +--- + +# Settings — Radio & User + +Configure your radio hardware and user identity parameters. + +## 使用者設定 + +### User Profile + +| 設定 | 描述說明 | +| ----------------- | ------------------------------------------------------------------------------------- | +| 長名稱 | Your display name (up to 39 characters) | +| 簡短名稱 | 4-character abbreviated name | +| Licensed Operator | Enable if you hold an amateur radio license (enables higher power) | + +### Applying Changes + +After modifying settings, tap **Save** to write the configuration to your radio. The device may reboot to apply changes. + +## 無線電配置 + +### 設備設置 + +| 設定 | 描述說明 | 默認 | +| ------------------------------------------ | ----------------------------------------------------------------------- | -------- | +| 角色 | Node behavior (Client, Router, etc.) | 用戶端 | +| ## Rebroadcast Mode轉發廣播模式 | How the node retransmits messages | 全部 | +| Node Info Broadcast (s) | Interval for broadcasting node info | 10800 | +| Double-tap Button | Action for double-tap button press | Disabled | + +### LoRa規劃 + +| 設定 | 描述說明 | 默認 | +| ---------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------- | +| 地區 | Regulatory region for frequency bands | Unset (must configure) | +| 數據機預設值 (Modem Preset) | Speed/range tradeoff | LongFast | +| 躍點限制 | Maximum retransmit hops | 3 | +| TX Power | Transmission power (dBm); 0 = max allowed for region | 0 (region max) | +| 頻率偏移量 | Fine-tune frequency (MHz) | 0 | +| Channel Bandwidth | Bandwidth setting | Default for preset | + +> ⚠️ **Important:** You **must** set your region before transmitting. Operating without the correct region may violate local radio regulations. See the [region configuration guide](https://meshtastic.org/docs/getting-started/initial-config) on meshtastic.org for details. + +### Modem Presets + +| Preset | 範圍 | 速度 | SNR Limit | Best For | +| ------------------ | ----------------------- | ------------------------- | ------------------------ | -------------------------------------------------------------------------------------------------------- | +| 短 Turbo | ~1 km | 21.9 kbps | −5 dB | Dense urban with line-of-sight; data-heavy applications | +| 短 快 | ~3 km | 10.9 kbps | −7.5 dB | Urban neighborhoods; buildings within a few blocks | +| 短 慢 | ~5 km | 5.5 kbps | −10 dB | Suburban short-range; moderate building density | +| 中等快 | ~5 km | 5.5 kbps | −10 dB | Suburban areas; moderate building density | +| 中等慢 | ~8 km | 1.1 kbps | −12.5 dB | Suburban/rural; moderate range with slower speed | +| Long Turbo | ~10 km | 4.4 kbps | −10 dB | Similar range to Long Fast but with 500 kHz bandwidth; faster throughput | +| Long Fast | ~10 km | 1.1 kbps | −12.5 dB | **General use (default)** — balanced range and speed | +| 長度中等的 | ~20 km | 0.34 kbps | −15 dB | Rural with some terrain; occasional use | +| Lite Fast | ~5 km | 5.5 kbps | −10 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Medium Fast | +| Lite Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 866 MHz SRD band (125 kHz BW); comparable to Long Fast | +| Narrow Fast | ~5 km | 2.7 kbps | −10 dB | EU 868 MHz band (62.5 kHz BW); avoids interference with other devices | +| Narrow Slow | ~10 km | 1.1 kbps | −12.5 dB | EU 868 MHz band (62.5 kHz BW); comparable to Long Fast | +| ~~Long Slow~~ | ~30 km | 0.18 kbps | −17.5 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | +| ~~Very Long Slow~~ | ~40+ km | 0.09 kbps | −20 dB | ⚠️ **Deprecated** — still selectable but may be removed in a future firmware release | + +#### Choosing a Modem Preset + +The modem preset controls the fundamental tradeoff between **range** and **data rate**: + +- **Slower presets** use more spreading, making signals decodable at weaker signal levels (lower SNR limit). This means longer range but fewer bytes per second. +- **Faster presets** pack more data per transmission but require a stronger signal to decode. + +**Practical guidance:** + +- **Urban mesh (many nodes, short distances):** Use **Long Fast** (default) or **Short Fast**. Higher speed means less airtime congestion when many nodes share the channel. +- **Rural/sparse mesh (few nodes, long distances):** Use **Long Moderate**. Range matters more than speed when nodes are far apart. +- **EU 866/868 MHz regulatory compliance:** Use **Lite Fast**, **Lite Slow**, **Narrow Fast**, or **Narrow Slow** — these are optimized for the EU SRD/868 MHz bands with narrower bandwidths. +- **Fixed infrastructure links:** Use **Short Turbo** or **Long Turbo** for dedicated point-to-point links with good antennas and line-of-sight. +- **Mixed environments:** Stick with **Long Fast** — it's the community default and ensures compatibility with others in your area. + +> ⚠️ **Important:** All nodes on the same channel **must** use the same modem preset. Nodes with mismatched presets cannot communicate even if they share the same frequency and encryption key. + +> 💡 **Tip:** The range estimates above assume flat terrain and modest antennas. Elevation advantage (hilltop, rooftop) dramatically increases effective range. A well-placed Router with Long Fast can often outperform a ground-level node with Long Slow. + +### 顯示設置 + +| 設定 | 描述說明 | +| ----------------- | ------------------------------------------------------------------------------------ | +| 螢幕逾時 | Time before display sleeps | +| 顯示單位 | Metric or Imperial | +| OLED類型 | Auto, SSD1306, SH1106, SH1107 | +| 羅盤方位 | Rotation offset for compass display (0°, 90°, 180°, 270°) | +| ~~Compass North~~ | ⚠️ **Deprecated** — replaced by Compass Orientation; still visible in older firmware | + +### 位置設定 + +| 設定 | 描述說明 | +| ----------------------------------------- | ---------------------------------- | +| GPS Enabled | Enable/disable GPS | +| GPS 更新間隔 | How often to acquire GPS fix | +| Position Broadcast (s) | How often to share position | +| 智慧定位 | Enable movement-based broadcasting | +| 固定位置 | Use a manually set position | + +### 電源設定 + +| 設定 | 描述說明 | +| --------------------------------------- | --------------------------------------- | +| 省電模式 | Enable low-power sleep mode | +| Shutdown After (s) | Auto-shutdown idle timer | +| ADC Multiplier | Battery voltage calibration factor | +| Wait Bluetooth (s) | Time to wait for BLE connection at boot | +| Mesh SDS Timeout (s) | Super-deep-sleep timeout | + +### 網路配置 + +| 設定 | 描述說明 | +| ------------- | ---------------------------------------------------- | +| 啟用 WiFi | Enable WiFi radio (ESP32 devices) | +| WiFi SSID | Network name to connect to | +| WiFi PSK | 網路密碼 | +| NTP 伺服器 | Time synchronization server | +| Syslog Server | Remote logging server | + +![IP address field](/assets/screenshots/settings_ipv4_field.png) + +### 藍牙配置 + +| 設定 | 描述說明 | +| ----------------- | ------------------------------------------------------------------------- | +| Bluetooth Enabled | Enable/disable BLE radio | +| 配對模式 | Fixed PIN, Random PIN, or No PIN | +| 固定 PIN | PIN code for pairing (default: 123456) | + +### 安全性設定 + +| 設定 | 描述說明 | +| -------------------------------- | -------------------------------------------------------------------------- | +| 公鑰 | Your node's public key (read-only) | +| 管理金鑰 | Key for remote administration | +| 私鑰 | Your node's private key (handle securely) | +| Admin Channel Enabled - 管理員頻道已啟用 | Allow admin commands via channel | +| 除錯日誌 | Output live debug logging over serial/bluetooth | +| Serial Enabled | Enable serial console access (moved from Device Config) | +| 管理模式 | Restrict non-admin channel changes | + +![Password field](/assets/screenshots/settings_password_field.png) + +Settings use standard preference controls — dropdowns, toggles, and sliders: + +| Control | 螢幕截圖 | +| -------- | ------------------------------------------------------ | +| Dropdown | ![Dropdown](/assets/screenshots/settings_dropdown.png) | +| Toggle | ![Toggle](/assets/screenshots/settings_switch.png) | +| Slider | ![Slider](/assets/screenshots/settings_slider.png) | + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — optional feature modules and device administration +- [Signal Meter](signal-meter) — how modem presets affect signal quality thresholds +- [LoRa configuration](https://meshtastic.org/docs/configuration/radio/lora) — detailed LoRa settings reference on meshtastic.org +- [Initial configuration](https://meshtastic.org/docs/getting-started/initial-config) — region setup guide on meshtastic.org + +--- + diff --git a/docs/zh-rTW/user/signal-meter.md b/docs/zh-rTW/user/signal-meter.md new file mode 100644 index 000000000..d3337a428 --- /dev/null +++ b/docs/zh-rTW/user/signal-meter.md @@ -0,0 +1,225 @@ +--- +title: How the Meshtastic Signal Meter Works +nav_order: 15 +last_updated: 2026-05-13 +description: How the signal meter calculates quality from RSSI and SNR — LoRa spread spectrum, presets, and what the bars really mean. +aliases: + - signal + - signal-meter + - snr + - rssi +--- + +# How the Meshtastic Signal Meter Works + +The Meshtastic signal meter — the familiar bars or status color in the app — is calculated very differently than the "bars" on a traditional cell phone or Wi-Fi router. + +Most consumer devices simply measure how "loud" a signal is. However, because Meshtastic uses **LoRa (Long Range)** technology, its signal meter measures how **clear** the signal is, relative to the specific settings your mesh is using. + +--- + +## 1. Meshtastic is an open source, decentralized, off-grid, privacy-respecting, encrypted communications platform built on affordable, readily available hardware. It enables you and your friends to communicate securely with text messages, share locations, and more over long ranges. + +2. It's built on top of a software defined radio platform called LoRa, enabling inexpensive radios (based on popular chips like the ESP32, nRF52, and RP2040) to operate as long range, low power, and secure communicators. + +3. Common hardware includes devices like the RAK WisBlock series, T-Beam, Heltec, and LilyGo boards. + +4. Meshtastic supports communication over several radio channels, allowing you to separate traffic or experiment with different settings. You can configure parameters like the spreading factor, bandwidth, and coding rate to optimize for range, data rate, and reliability. These settings are often referred to as radio profiles, with common examples being "Long Fast" or "Mid Slow". + +5. Besides LoRa, Meshtastic devices can also communicate using BLE for short-range communication with smartphones and other devices. + +6. Meshtastic devices can be configured using a variety of methods, including: + - A mobile app (available for Android and iOS) + - A web-based interface + - A CLI + - An API + +7. Meshtastic can also be integrated with other systems using protocols like MQTT. + +8. You can extend the functionality of Meshtastic devices by writing your own firmware or connecting external sensors and devices using the GPIO, USB, UART, SPI, and I2C interfaces. + +9. Meshtastic devices can be powered by batteries, USB, or other power sources. + +10. Meshtastic supports Over-The-Air (OTA) firmware updates via LoRa, WiFi or Bluetooth. + +11. Meshtastic allows for end-to-end encryption of messages. + +12. Meshtastic devices can act as repeaters, extending the range of the network. The Two Metrics: "Loudness" vs. "Clarity" + +Every time the LoRa radio chip receives a message, it reports two measurements: + +- **RSSI (Received Signal Strength Indicator):** The **loudness** of the raw power hitting your antenna. +- **SNR (Signal-to-Noise Ratio):** The **clarity** of the signal compared to the background static. + +> **Tip — The Analogy:** Imagine you are trying to hear a friend talking to you. +> +> - **RSSI** is how loud their voice is. +> - **The Noise Floor** is the background noise in the room (air conditioning, other people talking, traffic). +> - **SNR** is how easily you can distinguish your friend's voice from the background noise. + +If your friend shouts at you at a deafening rock concert, the signal is incredibly loud (High RSSI), but you still can't understand them because the background noise is louder (Bad SNR). Conversely, if your friend whispers to you in a dead-silent library, the signal is very weak (Low RSSI), but you can understand them perfectly (Great SNR). + +--- + +## 2. The Magic of LoRa: Hearing "Below the Noise Floor" + +For standard radios (like FM or Wi-Fi), if the background noise is louder than the signal (a negative SNR), the receiver just hears static. + +LoRa is special. It uses **"Spread Spectrum"** modulation, which allows the radio to mathematically pull a signal out of the air even when it is buried deep _underneath_ the background noise. This is why you will frequently see **negative SNR numbers** in Meshtastic (e.g., -10 dB, which means the signal is 10 decibels weaker than the background static). + +Depending on which Meshtastic preset you are using (e.g., `LongFast` vs. `ShortFast`), the radio has a specific **SNR Limit** — the absolute maximum amount of noise it can tolerate before the message is completely lost to the static. + +--- + +## 3. How the Signal Meter Calculates Quality + +The Meshtastic apps take both RSSI and SNR and run them through a specific formula to assign your signal a quality rating (None, Bad, Fair, or Good). It specifically scales these values based on the physical limits of the radio preset you are using. + +Here is exactly how the app decides how many bars (or what color) to show you: + +| Level | Bars | Criteria | Meaning | +| ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | +| 良好 | 3 | RSSI better than `-115 dBm` **AND** SNR better than `-7 dB` | Signal is both loud and clear — healthy connection. | +| 普通 | 2 | RSSI better than `-126 dBm` with good SNR, **OR** SNR better than `-15 dB` with good RSSI | Signal getting quieter or noisier, but still decodable. | +| 不良 | 1. **Overview**``` +Meshtastic is a project that allows you to use inexpensive LoRa radios as a long range, off-grid, decentralized communication platform. These radios, combined with readily available and very affordable microcontrollers like the ESP32, nRF52, and RP2040, create a network that can be used to send text messages, share locations, and more without relying on cellular or WiFi infrastructure. It's perfect for hiking, camping, or any situation where you need to stay connected beyond the reach of traditional networks. +```2. **Key Components**``` +* **LoRa Radios:** These radios provide the long-range communication capabilities. The RAK Wireless modules are a popular choice. +* **Microcontrollers:** The brains of the operation. ESP32, nRF52, and RP2040 are commonly used due to their low cost and capabilities. +* **GPS (Optional):** For location sharing. Many devices, like the T-Beam, have built-in GPS. +* **Battery (Optional):** For portable use. +* **Enclosure (Optional):** To protect the hardware. +```3. **Popular Devices**``` +* **T-Beam:** A popular board with ESP32, LoRa, and GPS. +* **Heltec WiFi LoRa 32:** Another popular ESP32-based board with LoRa. +* **LilyGo Boards:** LilyGo offers a variety of ESP32 and nRF52 based boards with LoRa. +```4. **Features**``` +* **Text Messaging:** Send and receive text messages over the LoRa network. +* **Location Sharing:** Share your location with other users on the network (requires GPS). +* **Encryption:** Messages can be encrypted for privacy. +* **Mesh Networking:** The network automatically routes messages through other nodes to reach the destination. +* **Off-Grid Communication:** No cellular or WiFi required. +* **Channel Settings:** Customize channel settings for different regions and use cases (Long Fast, Mid Slow, etc.). +```5. **Software & Firmware**``` +* **Meshtastic Firmware:** The core software that runs on the microcontrollers. +* **Meshtastic Mobile App:** For configuring and interacting with the devices. Available on Android and iOS. +* **CLI (Command Line Interface):** For advanced configuration and debugging. +* **API (Application Programming Interface):** For integrating Meshtastic with other applications. +```6. **Hardware Setup**``` +* **Flashing Firmware:** You'll need to flash the Meshtastic firmware onto your microcontroller. This is typically done using a USB connection and a flashing tool. +* **Connecting Peripherals:** Connect the LoRa radio and any other peripherals (GPS, battery) to the microcontroller. +* **Antenna:** Attach an appropriate antenna to the LoRa radio. +```7. **Configuration**``` +* **Region Settings:** Configure the correct region settings for your location. +* **Channel Settings:** Choose a channel or create a custom channel. +* **Encryption:** Enable encryption for secure communication. +* **Power Settings:** Adjust power settings to optimize battery life. +```8. **Technical Details**``` +* **LoRa Modulation:** Uses LoRa modulation for long-range communication. +* **Frequency Bands:** Operates on various frequency bands depending on the region (e.g., 915 MHz in North America, 868 MHz in Europe). +* **Microcontroller Interfaces:** Uses various interfaces for communication between the microcontroller and peripherals, including GPIO, USB, UART, SPI, and I2C. +* **BLE (Bluetooth Low Energy):** Used for initial configuration and communication with the mobile app. +* **WiFi:** Some devices support WiFi for OTA (Over-The-Air) firmware updates. +* **MQTT:** Supports MQTT for integration with other systems. +```9. **Use Cases**``` +* **Hiking and Camping:** Stay connected with your group in areas without cellular coverage. +* **Emergency Communication:** Provide a backup communication system in case of emergencies. +* **Disaster Relief:** Establish communication networks in areas affected by disasters. +* **Rural Communication:** Connect communities in remote areas. +* **IoT Applications:** Use Meshtastic for various IoT applications that require long-range communication. +```10. **Resources**``` +* **Meshtastic Website:** [https://meshtastic.org/](https://meshtastic.org/) +* **Meshtastic Documentation:** [https://meshtastic.org/docs/](https://meshtastic.org/docs/) +* **Meshtastic Forums:** [https://meshtastic.discourse.group/](https://meshtastic.discourse.group/) +```1) **概觀** + + Meshtastic 是一個專案，讓你可以使用便宜的 LoRa 無線電作為長距離、離線、去中心化的通訊平台。這些無線電，結合了容易取得且非常實惠的微控制器，像是 ESP32、nRF52 和 RP2040，創建了一個網路，可以用來傳送簡訊、分享位置等等，而不需要依賴行動網路或 WiFi 基礎設施。它非常適合健行、露營，或任何你需要保持連線，但又超出傳統網路覆蓋範圍的情況。 + +2) **主要組件** + + - **LoRa 無線電:** 提供長距離通訊能力。 RAK Wireless 模組是一個很受歡迎的選擇。 + - **微控制器:** 運作的大腦。 ESP32、nRF52 和 RP2040 因為它們的低成本和功能而被廣泛使用。 + - **GPS (可選):** 用於位置分享。 許多裝置，像是 T-Beam，都有內建 GPS。 + - **電池 (可選):** 用於攜帶型使用。 + - **外殼 (可選):** 保護硬體。 + +3) **熱門裝置** + + - **T-Beam:** 一個受歡迎的板子，具有 ESP32、LoRa 和 GPS。 + - **Heltec WiFi LoRa 32:** 另一個受歡迎的基於 ESP32 的板子，具有 LoRa。 + - **LilyGo Boards:** LilyGo 提供各種基於 ESP32 和 nRF52 的板子，具有 LoRa。 + +4) **功能** + + - **簡訊傳輸:** 透過 LoRa 網路傳送和接收簡訊。 + - **位置分享:** 與網路上其他使用者分享你的位置 (需要 GPS)。 + - **加密:** 可以加密訊息以保護隱私。 + - **網狀網路:** 網路會自動透過其他節點路由訊息，以到達目的地。 + - **離線通訊:** 不需要行動網路或 WiFi。 + - **頻道設定:** 客製化不同地區和使用案例的頻道設定 (Long Fast、Mid Slow 等)。 + +5) **軟體與 Firmware** + + - **Meshtastic Firmware:** 在微控制器上執行的核心軟體。 + - **Meshtastic Mobile App:** 用於配置和與裝置互動。 可在 Android 和 iOS 上使用。 + - **CLI (Command Line Interface):** 用於進階配置和除錯。 + - **API (Application Programming Interface):** 用於將 Meshtastic 與其他應用程式整合。 + +6) **硬體設定** + + - **刷入 Firmware:** 你需要將 Meshtastic firmware 刷入你的微控制器。 這通常是使用 USB 連線和刷入工具來完成的。 + - **連接週邊設備:** 將 LoRa 無線電和任何其他週邊設備 (GPS、電池) 連接到微控制器。 + - **天線:** 將適當的天線連接到 LoRa 無線電。 + +7) **配置** + + - **區域設定:** 為你的位置配置正確的區域設定。 + - **頻道設定:** 選擇一個頻道或創建一個自定義頻道。 + - **加密:** 啟用加密以進行安全通訊。 + - **電源設定:** 調整電源設定以優化電池壽命。 + +8) **技術細節** + + - **LoRa 調變:** 使用 LoRa 調變進行長距離通訊。 + - **頻率範圍:** 根據地區在不同的頻率範圍上運作 (例如，北美為 915 MHz，歐洲為 868 MHz)。 + - **微控制器介面:** 使用各種介面在微控制器和週邊設備之間進行通訊，包括 GPIO、USB、UART、SPI 和 I2C。 + - **BLE (Bluetooth Low Energy):** 用於初始配置和與行動應用程式的通訊。 + - **WiFi:** 某些裝置支援 WiFi 用於 OTA (Over-The-Air) firmware 更新。 + - **MQTT:** 支援 MQTT 用於與其他系統整合。 + +9) **使用案例** + + - **健行和露營:** 在沒有行動網路覆蓋的地區與你的團隊保持聯繫。 + - **緊急通訊:** 在緊急情況下提供備份通訊系統。 + - **災害救援:** 在受災害影響的地區建立通訊網路。 + - **農村通訊:** 連接偏遠地區的社群。 + - **IoT 應用:** 將 Meshtastic 用於各種需要長距離通訊的 IoT 應用。 + +10) **資源** + + - **Meshtastic Website:** [https://meshtastic.org/](https://meshtastic.org/) + - **Meshtastic Documentation:** [https://meshtastic.org/docs/](https://meshtastic.org/docs/) + - **Meshtastic Forums:** [https://meshtastic.discourse.group/](https://meshtastic.discourse.group/) | Falls between Fair and None thresholds | At the edge of range or experiencing interference. | +| 無 | 0 | RSSI worse than `-126 dBm` **AND** SNR worse than `-15 dB` | Transmission completely buried in noise. | + +--- + +## 4. What This Means for You + +Because Meshtastic's meter acts as a **"Clarity Meter"**, it behaves differently than what most people expect: + +> **Tip — Don't panic over low RSSI:** You might see a seemingly terrible RSSI value like `-118 dBm`. On a cell phone, you would have zero bars. But if you have an SNR of `+2 dB`, Meshtastic will still show a strong signal! _The library is quiet, so the whisper is heard perfectly._ + +> **Warning — Watch out for local noise:** If you hook up a massive antenna and see a great RSSI (e.g., `-90 dBm`) but your signal meter is only showing **1 Bar (Bad)**, you have a problem. It means you have local interference — perhaps a cheap power supply, a noisy computer, or a nearby radio tower — creating so much static that it is drowning out your mesh. + +## Where Signal Information Appears + +In the app, signal data is shown in several places: + +- **Node list** — signal bars icon next to each node +- **Node detail** — SNR, RSSI, and signal quality in the device metrics section +- **Traceroute** — per-hop signal quality for each relay node +- **Signal metrics** — historical SNR and RSSI data in the metrics charts + +![Node entry showing SNR, RSSI values and colored signal bars](/assets/screenshots/nodes_signal_info.png) + diff --git a/docs/zh-rTW/user/tak.md b/docs/zh-rTW/user/tak.md new file mode 100644 index 000000000..c0009aab8 --- /dev/null +++ b/docs/zh-rTW/user/tak.md @@ -0,0 +1,126 @@ +--- +title: TAK Integration +nav_order: 10 +last_updated: 2026-05-13 +description: Interoperate with ATAK and WinTAK — CoT position sharing, TAK roles, and plugin setup. +aliases: + - tak + - atak + - team-awareness-kit +--- + +# TAK Integration + +Meshtastic integrates with the Team Awareness Kit (TAK) ecosystem, enabling interoperability between Meshtastic mesh devices and TAK applications like ATAK and WinTAK. + +## 概觀 + +The TAK module allows Meshtastic nodes to: + +- Share position data in TAK-compatible CoT (Cursor on Target) format +- Appear as team members on TAK map displays +- Receive TAK PLI (Position Location Information) messages + +## 設定 + +### 先決條件 + +- ATAK (Android Team Awareness Kit) or WinTAK installed +- Meshtastic ATAK Plugin installed +- TAK module enabled on your Meshtastic radio + +### 設定 + +1. Navigate to **Settings → Module Config → TAK**. +2. Enable the TAK module. +3. Configure the TAK team/group settings: + +![Module toggle switch](/assets/screenshots/settings_switch.png) + +| 設定 | 描述說明 | +| --- | -------------------------- | +| 已啟用 | Activate TAK interop | +| 模式 | TAK-compatible output mode | + +### ATAK Plugin Setup + +1. Install the Meshtastic ATAK Plugin from the plugin repository. +2. Open ATAK and enable the Meshtastic plugin. +3. The plugin bridges messages between ATAK and your mesh network. + +## TAK Roles + +Nodes configured with TAK-related roles behave differently from standard clients: + +| 角色 | 描述說明 | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **TAK** | Full TAK interoperability — sends and receives CoT data, chat messages, and PLI updates. Functions as a standard client plus TAK bridge. | +| **TAK Tracker** | Position-only TAK output — automatically broadcasts PLI at regular intervals without user interaction. Optimized for unattended position beacons (vehicles, equipment, waypoints). Does not relay chat messages. | + +> 💡 **Tip:** Use **TAK Tracker** for devices that only need to report position (e.g., a radio mounted in a vehicle). Use **TAK** for devices where users actively participate in TAK operations. + +### CoT (Cursor on Target) Format + +TAK messages use the Cursor on Target XML format — a military standard for sharing situational awareness data. Meshtastic converts its internal protobuf messages to CoT format when bridging to TAK systems, so no manual format conversion is needed. + +## TAK Identity + +When using TAK roles, your node broadcasts identity information that appears on TAK maps: + +| 設定 | 描述說明 | +| -------- | ---------------------------------------------------------------------------------------------------------------- | +| Team | Your team color on the TAK map (e.g., Blue, Red, Cyan, Green) | +| 角色 | Your operational role (Team Member, Team Lead, HQ, Medic, RTO, etc.) | +| Callsign | Your TAK callsign (defaults to your Meshtastic long name) | + +These settings appear in **Settings → Module Config → TAK** when the TAK module is enabled. + +> 💡 **Tip:** Team/role colors are the standard TAK affiliation colors. Coordinate with your TAK team to use consistent team assignments. + +## Wire Format (V1 / V2) + +Meshtastic supports two TAK wire formats: + +| Format | 相容性 | 特色 | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------- | +| V1 (Legacy) | ATAK Plugin v1.x, older firmware | Basic CoT position sharing only | +| V2 (Current) | ATAK Plugin v2.x, firmware 2.3+ | Full CoT support including chat, routes, zstd compression | + +The app automatically selects V2 when both sides support it. No manual configuration needed — the TAK module negotiates format based on firmware capabilities. + +## Usage with ATAK + +Once configured: + +- Meshtastic nodes appear as markers on the ATAK map with callsign labels +- Chat messages can bridge between mesh and TAK networks +- Position updates flow bidirectionally between Meshtastic and TAK +- TAK Tracker nodes broadcast PLI automatically — their positions appear on ATAK maps without any ATAK-side configuration + +> ⚠️ **Note:** TAK integration requires specific node roles and module configuration. Standard client nodes don't automatically participate in TAK operations. + +## 故障排除 + +| Problem | Cause | Solution | +| -------------------------------- | ------------------------------------- | ----------------------------------------------------------------------- | +| Node doesn't appear on ATAK map | TAK module disabled or wrong role | Verify TAK module is enabled and node role is TAK or TAK Tracker | +| Position updates are stale | GPS fix lost or interval too long | Check GPS status; reduce position broadcast interval in Position Config | +| ATAK plugin shows "disconnected" | BLE connection lost or plugin crashed | Reconnect Bluetooth in Meshtastic app, then restart ATAK plugin | +| Chat messages not bridging | V1 format doesn't support chat | Ensure both nodes run firmware 2.3+ for V2 wire format | +| CoT data not flowing | Channel mismatch | All TAK nodes must be on the same channel with matching encryption | + +## Security Considerations + +- TAK data shares your position and callsign information +- Ensure your channel encryption is configured when using TAK in sensitive environments +- The TAK module respects the same channel encryption as other Meshtastic messages + +## Related Topics + +- [Settings — Modules & Admin](settings-module-admin) — TAK module configuration +- [Nodes](nodes) — TAK and TAK Tracker roles in the node list +- [Map & Waypoints](map-and-waypoints) — node positions on the map +- [ATAK plugin guide](https://meshtastic.org/docs/software/integrations/atak-plugin) — detailed ATAK setup on meshtastic.org + +--- + diff --git a/docs/zh-rTW/user/telemetry-and-sensors.md b/docs/zh-rTW/user/telemetry-and-sensors.md new file mode 100644 index 000000000..a44efe485 --- /dev/null +++ b/docs/zh-rTW/user/telemetry-and-sensors.md @@ -0,0 +1,118 @@ +--- +title: Telemetry & Sensors +nav_order: 9 +last_updated: 2026-05-13 +description: Sensor data on the mesh — supported environment, air quality, and power sensors, plus configuration and viewing guides. +aliases: + - sensors + - environment + - weather + - power-metrics +--- + +# Telemetry & Sensors + +Meshtastic nodes can collect and share sensor data across the mesh network. + +## 概觀 + +Telemetry allows nodes equipped with sensors to broadcast environmental, power, and device health information. This data is visible on the node detail screen and can be logged over time. + +## 裝置遙測 + +All Meshtastic nodes report basic device telemetry: + +| 公制（公里/公尺） | 描述說明 | Typical Range | +| ------------------ | ------------------------------ | ------------------------------------------------------------------ | +| Battery Level | Charge percentage | 0–100% | +| 電壓 | Battery voltage | 3.0–4.2V (LiPo) | +| 頻道使用量 | % of airtime used locally | 0–100% | +| Air Utilization TX | % of airtime used by this node | 0–100% | +| 運行時間 | Seconds since last boot | Varies | + +## Environment Sensors + +Supported environmental sensors: + +### Temperature & Humidity + +| 感測器 | 溫度 | 濕度 | 氣壓 | 備註 | +| ------- | -- | -- | -- | ----------------------- | +| BME280 | ✓ | ✓ | ✓ | Recommended all-in-one | +| BME680 | ✓ | ✓ | ✓ | Adds gas resistance/IAQ | +| SHT31 | ✓ | ✓ | — | High accuracy | +| MCP9808 | ✓ | — | — | Precision temperature | +| LPS22 | — | — | ✓ | Pressure only | + +### Air Quality + +| 感測器 | 公制（公里/公尺） | 備註 | +| -------- | -------------------------------------------------- | -------------------------- | +| BME680 | Gas Resistance / IAQ | Volatile organic compounds | +| PMSA003I | PM1.0, PM2.5, PM10 | Particulate matter | +| SEN55 | PM, NOx, VOC, Temp, Humidity | Multi-sensor | + +### Light & UV + +| 感測器 | 公制（公里/公尺） | +| -------- | -------------------------------------- | +| OPT3001 | Ambient light (lux) | +| VEML7700 | Ambient light (lux) | +| LTR390 | UV index | + +## 電源計量資料 + +Nodes with INA-series power sensors can report: + +| 公制（公里/公尺） | 描述說明 | +| ----------- | ----------------------------------------- | +| Bus Voltage | Supply rail voltage | +| 目前 | Power consumption (mA) | +| 電力 | Calculated power (mW) | + +Useful for monitoring solar charging or battery health on remote nodes. + +## Configuring Telemetry + +1. Navigate to **Settings → Module Config → Telemetry**. +2. Set reporting intervals: + - **Device Metrics Interval** — how often to broadcast device metrics + - **Environment Metrics Interval** — how often to broadcast sensor data +3. Enable specific sensor types as needed. + +### Recommended Intervals + +| Use Case | Device (s) | Environment (s) | +| ------------------------------------------ | ----------------------------- | ---------------------------------- | +| Urban mesh (many nodes) | 3600 | 3600 | +| Rural mesh (few nodes) | 900 | 900 | +| Weather station | 900 | 300 | +| Battery conservation | 7200 | 7200 | + +> ⚠️ **Note:** Shorter intervals increase airtime usage and battery drain across the mesh. + +## Viewing Telemetry + +1. Navigate to **Nodes** and select a node. +2. Telemetry sections show on the detail screen: + - Device Metrics (always available) + - Environment Metrics (if sensors present) + - Power Metrics (if INA sensor present) +3. Historical graphs show trends over time. + +![Telemetry actions](/assets/screenshots/node-metrics_telemetric_actions.png) + +## 故障排除 + +- **No environment data showing?** The remote node needs a physical sensor connected (e.g., BME280 on I2C). Device telemetry (battery, uptime) is always available, but environment metrics require hardware. +- **Stale readings?** Check the reporting interval — very long intervals (7200s+) mean data updates infrequently. Also verify the remote node is still online. +- **Sensor conflict on I2C bus?** Some sensors share I2C addresses. If you have multiple sensors on the same bus, check for address collisions in the radio's serial debug output. + +## Related Topics + +- [Node Metrics](node-metrics) — view telemetry data on the node detail screen +- [Settings — Modules & Admin](settings-module-admin) — telemetry module configuration +- [Units & Locale](units-and-locale) — temperature and pressure display units + +--- + diff --git a/docs/zh-rTW/user/translate.md b/docs/zh-rTW/user/translate.md new file mode 100644 index 000000000..a39793573 --- /dev/null +++ b/docs/zh-rTW/user/translate.md @@ -0,0 +1,97 @@ +--- +title: Translate the App +parent: User Guide +nav_order: 17 +last_updated: 2026-05-13 +aliases: + - translate + - crowdin + - localization +--- + +# Translate the App + +Contributing translations helps make Meshtastic accessible to a wider audience. The app uses [Crowdin](https://crowdin.com/) to manage community translations for both the user interface and in-app documentation. + +--- + +## What Gets Translated + +| Resource | Source Location | 備註 | +| ----------------- | ------------------------------------- | ---------------------------------------------------------------------- | +| UI strings | `composeResources/values/strings.xml` | Buttons, labels, messages, and all user-visible text | +| User Guide pages | `docs/user/*.md` | In-app documentation shown in Help & Documentation | +| Fastlane metadata | `fastlane/metadata/android/en-US/` | App Store listing title, description, and changelogs | + +> **Note — Developer Guide pages are English-only.** Code-focused documentation targeting contributors is not translated. + +--- + +## 如何貢獻 + +1. **Visit the Crowdin project.** Open the [Meshtastic Android Crowdin project](https://crowdin.com/project/meshtastic-android) and sign in or create a free account. +2. **Choose your language.** Select an existing language or request a new one by opening a [GitHub issue](https://github.com/meshtastic/Meshtastic-Android/issues/new). +3. **Translate strings.** Crowdin shows the English source on the left and your translation on the right. Translate each string and save. +4. **Review context.** Many strings include screenshots or context comments — check these to understand where the text appears in the app. +5. **Submit.** Approved translations are automatically merged into the next release. + +> **Tip — Keep translations short.** UI strings often appear in buttons, chips, or narrow columns. If a translation is significantly longer than the English original, consider abbreviating where the meaning stays clear. + +--- + +## Adding a New Language + +If your language is not yet listed on Crowdin: + +1. Open an issue on [GitHub](https://github.com/meshtastic/Meshtastic-Android/issues/new) requesting the new locale. +2. A maintainer will add the language to Crowdin and configure `crowdin.yml`. +3. Once added, you can begin translating immediately. + +--- + +## How Translations Are Organized + +The Android app uses **Compose Multiplatform resources** for all user-visible strings: + +``` +core/resources/src/commonMain/composeResources/ +├── values/ ← English (default) +│ └── strings.xml +├── values-de/ ← German +│ └── strings.xml +├── values-fr/ ← French +│ └── strings.xml +└── ... +``` + +In-app documentation follows a similar pattern under `docs/`: + +``` +docs/ +├── user/ ← English source (default) +│ ├── onboarding.md +│ └── ... +├── fr/user/ ← French translations +│ ├── onboarding.md +│ └── ... +└── ... +``` + +The app automatically selects the correct locale based on your device's **Language & Region** settings. + +--- + +## Translation Guidelines + +- **Do not translate** technical terms like "LoRa", "MQTT", "BLE", "TAK", "SNR", or "RSSI" — these are universal. +- **Keep placeholders intact.** Strings like `%1$s` or `%d` are filled in at runtime. Do not remove or reorder them unless the grammar of your language requires it. +- **Match tone.** The app uses a friendly, direct voice. Avoid overly formal language. +- **Test if possible.** Switch your device language and open the app to see how translations look in context. + +--- + +## Questions? + +If you have questions about a specific string's context or need help getting started, open a discussion on the [Meshtastic GitHub Discussions](https://github.com/meshtastic/Meshtastic-Android/discussions) page. + +感謝您協助擴展 Meshtastic 的觸及範圍！ diff --git a/docs/zh-rTW/user/units-and-locale.md b/docs/zh-rTW/user/units-and-locale.md new file mode 100644 index 000000000..967dd25e6 --- /dev/null +++ b/docs/zh-rTW/user/units-and-locale.md @@ -0,0 +1,118 @@ +--- +title: Units, Measurement & Locale +parent: User Guide +nav_order: 16 +last_updated: 2026-05-12 +--- + +# Units, Measurement & Locale + +The Meshtastic app automatically displays temperatures, distances, speeds, and times in the units your device is configured to use — no settings to change inside the app. + +--- + +## 運作方式 + +Meshtastic radios always transmit data in **metric units** (meters, °C, km/h, hPa, etc.). When the app receives this data, it uses the `MetricFormatter` utility to convert and display values in whatever unit system your device's locale specifies. + +On Android, your measurement preferences are determined by your system **Language & Region** settings. On Desktop (JVM), the app uses the JVM's default `Locale`. + +> **Tip — You never need to toggle units inside the app.** Change your system measurement preferences and every screen in Meshtastic updates automatically — node details, telemetry charts, weather, altitude, and more. + +--- + +## 溫度 + +Temperature values from environment sensors are transmitted as **°C** and displayed based on your device's temperature unit preference. + +![Environment metrics with temperature](/assets/screenshots/nodes_environment_metrics.png) + +| Your Setting | You See | +| ------------ | ------- | +| Celsius | 22°C | +| Fahrenheit | 72°F | + +This affects all temperature displays throughout the app: node environment telemetry, soil temperature, dew point, and telemetry chart axes. + +## Distance & Altitude + +Distances between nodes and GPS altitudes are transmitted as **meters** and automatically scaled and converted. + +![Distance info display](/assets/screenshots/nodes_distance_info.png) + +| Your Setting | Small Distance | Large Distance | 海拔高度 | +| -------------------------------- | -------------- | ---------------------- | -------- | +| 公制（公里/公尺） | 350 m | 2.5 km | 1,200 m | +| Imperial (US) | 1,148 ft | 1.6 mi | 3,937 ft | + +The app uses natural scaling — short distances stay in meters or feet, while longer distances switch to kilometres or miles automatically. + +### Where these appear + +- **Node list** — distance and bearing to each node +- **Node detail** — altitude, distance from your position +- **Map** — waypoint distances, traceroute hop distances +- **Compass** — distance to selected node + +## 速度 + +GPS ground speed is displayed in your locale's preferred speed unit. + +| Your Setting | You See | +| -------------------------------- | ------- | +| 公制（公里/公尺） | 12 km/h | +| Imperial (US) | 7 mph | + +## 風速 + +Wind speed and gust data from environment sensors are transmitted as **m/s** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ------- | +| 公制（公里/公尺） | 5 m/s | +| Imperial (US) | 11 mph | + +Wind readings appear in the **Node Detail** environment section and the **Environment Telemetry** charts. + +## Rainfall + +Rainfall measurements (1-hour and 24-hour totals) are transmitted as **mm** and converted for display. + +| Your Setting | You See | +| -------------------------------- | ---------------------- | +| 公制（公里/公尺） | 12 mm | +| Imperial (US) | 0.5 in | + +## Units That Never Change + +Some units are international standards and are displayed the same way regardless of your locale: + +| Measurement | Unit | Why | +| -------------------------------- | ------------------------------ | ------------------------------------- | +| 氣壓 | hPa | International meteorological standard | +| Heading / bearing | ° (degrees) | Universal navigation convention | +| 輻射 | μR/hr | Standard dosimetry unit | +| GPS coordinates | decimal degrees | Universal geographic standard | +| Humidity, battery, soil moisture | % | Universal | + +## Date & Time + +All timestamps throughout the app — last heard, message times, telemetry logs, chart axes — follow your device's date and time preferences. + +| 設定 | What It Controls | 範例 | +| ---------------- | ---------------- | ------------------------------------------------ | +| **24-Hour Time** | Clock format | 14:30 vs 2:30 PM | +| **Date Format** | Date ordering | 09/05/2026 vs 05/09/2026 | + +The app also uses **relative time** where it makes sense — for example, "5 min ago" or "2 hours ago" in the node list — which is automatically localised into your device language. + +## Changing Your Measurement System (Android) + +On Android, your measurement system (metric vs imperial) is tied to your region setting: + +1. Open **Android Settings → System → Language & Region** +2. Change your **Region** or **Measurement units** preference +3. Return to Meshtastic — values update immediately + +> **Tip — The app uses `MetricFormatter` from `core:common`.** All measurement formatting is handled by a shared KMP utility that respects your platform's locale. Developers adding new measurement displays should use `MetricFormatter` rather than hard-coding unit conversions. +