DOCSEARCHbyAlgolia
Submit Docs

Meshtastic Hardware Documentation

website·Indexed 39 days ago

https://meshtastic.org/

Hardware guides and specifications for Meshtastic-powered devices, including RAK Wireless WisMesh (Pocket, Repeater, Tap, Gateway), LILYGO (T-Beam, T-Echo, T-Deck, T-Watch, T5 E-Paper), Seeed Studio XIAO, and other compatible nodes and peripherals.

Tokens
225.4K
Snippets
568
Records
2K
Agent score
71%

What's inside Meshtastic

  1. Overview of Meshtastic BaseUI features

    BaseUI is the redesigned default interface for Meshtastic OLED and basic TFT screens. It introduces an auto-hiding menu bar with action menus for quick access to common tasks. Key capabilities include:

    • On-Device Configuration: Set Region and Timezone directly on the device.
    • Digital Clock: Supports 12/24-hour preferences.
    • Favorites: Dedicated icon in the menu bar for quick access to important nodes.
    • Action Menus: Context-specific shortcuts available via the menu bar:
      • Home: Sleep screen or send preset messages.
      • Messages: Dismiss recent messages or reply with presets.
      • Position: Enable/disable GPS.
      • LoRa: Select LoRa region.
      • System: Configure beeps for notifications or system events.
      • Digital Clock: Select time zone from a list of common options.
      • Favorites: Send preset messages to a favorited node.

  2. Overview of Meshtastic Remote Administration

    Remote Administration allows secure management of Meshtastic nodes over the mesh network. By default, nodes only respond to administrative commands via local USB, Bluetooth, or TCP interfaces. Remote Admin enables these commands to be sent securely as Admin Messages over the mesh.

    Warning: This is an advanced feature. Incorrect settings applied to a remote node can cause it to disconnect from the mesh. It is recommended to trial settings on a test node first.

  3. Overview of Mesh-metrics for Meshtastic

    Mesh-metrics is a community-maintained script (developed by @cordelster) designed to collect performance and status metrics from Meshtastic devices. It works by using the Meshtastic CLI to send metrics requests to a list of devices connected via USB. The script outputs data in a format compatible with node_exporter, allowing the metrics to be ingested into a Prometheus or Victoria Metrics Time Series Database (TSDB) and visualized using Grafana dashboards.
    # Project source and setup details can be found at:
https://github.com/cordelster/mesh-metrics

  4. Overview of Meshtastic Transport Abstraction

    Meshtastic uses a transport abstraction layer to ensure the application works identically regardless of the underlying connection type. The architecture follows the flow: App $\rightarrow$ RadioController $\rightarrow$ Transport (BLE | Serial | TCP). Interfaces are defined in core:repository, while concrete implementations reside in core:network and core:ble.

  5. Overview of RAK WisMesh devices

    RAK WisMesh is a series of pre-built, ready-to-use Meshtastic devices. Unlike the modular WisBlock system, WisMesh devices are purpose-driven solutions that do not require manual assembly or additional hardware configuration for deployment.

  6. Overview of Meshtastic BaseUI

    BaseUI is the stock user interface designed for all Meshtastic devices equipped with screens. It serves as the foundational experience for users, providing an intuitive way to interact with the device independently of a smartphone app. It supports devices with OLED, EInk, or TFT displays.

  7. Overview of the Range Test module

    The Range Test module allows users to test the communication range between two Meshtastic nodes. It consists of a 'Sender' (a fixed node sending sequential packets) and a 'Receiver' (a mobile node, typically with GPS, that records the packets). Nodes are considered in range as long as sequential packets are received.

    Important Constraints:

    • Both the Sender and Receiver must have the module enabled.
    • To see range test messages on Android or Apple apps, the module must be enabled on the device.
    • The module automatically turns off after 8 hours to prevent network congestion.
    • Users should manually disable the module when not in use to avoid excessive airtime and channel spam.

  8. Overview of Seeed Studio Wio Series support

    The Seeed Studio Wio Series consists of development boards and modules for prototyping. While most models are intended for custom project integration, the Tracker L1 'Pro' variant is available as a ready-to-use handheld device with a pre-installed case and battery.

  9. Overview of Meshtastic Telemetry Module data types

    The Telemetry Module transmits four categories of data over the mesh:

    1. Device metrics: Battery Level, Voltage, Channel Utilization, and Airtime.
    2. Environment Metrics: General environmental data.
    3. Air Quality Metrics: Specific air quality readings.
    4. Health metrics: Heart rate, Oxygen Saturation, and body temperature (requires firmware compilation with specific macros enabled).

    Sensors connected via the I2C bus are automatically detected at startup. To transmit these readings, the corresponding Telemetry modules (Environment, Air Quality, or Health) must be enabled in the configuration.

  10. Overview and requirements for the Paxcounter module

    The Paxcounter module monitors foot traffic in a specific area by scanning for Wi-Fi and BLE (Bluetooth Low Energy) MAC addresses.

    Requirements:

    • Firmware: Version 2.2.17 or higher.
    • Hardware: Only compatible with ESP32 devices.
    • Critical Configuration: To operate the Paxcounter module, both Wi-Fi and Bluetooth must be switched off in the device's Network and Bluetooth settings.

  11. Overview of Meshtastic UI (MUI)

    Meshtastic UI (MUI) is an independent, on-device user interface for Meshtastic devices. It allows users to interact with the mesh network and modify basic settings directly on the hardware without requiring a companion phone application. While it covers most basic settings, some advanced configurations may still require pairing with a phone.

  12. Overview of the Meshtastic JavaScript library

    The Meshtastic JavaScript library provides a programmatic interface to interact with Meshtastic devices. It is compatible with web browsers, Node.js, and Deno applications. The core functionality is provided by the @meshtastic/core package.
    npm install @meshtastic/core