DE

Documentation

The MeshCore documentation, simplified for an easy start. Content is kept in sync automatically with the official docs (docs.meshcore.io).

01Getting Started
  • Introduction

    Welcome page for the official MeshCore documentation with quick-start links to FAQs, CLI commands, protocols, and more.

    Read
  • Frequently Asked Questions (FAQ)

    This documentation page provides answers to frequently asked questions about MeshCore, covering introduction, setup, server administration, T-Deck specific topics, general information, troubleshooting, and other questions.

    Read
  • QR Codes

    This document offers an overview of the QR Code formats supported by the MeshCore mobile app for sharing channels and contacts.

    Read
  • Local Documentation

    Instructions for building and viewing the MeshCore documentation locally using MkDocs.

    Read
02Operation & Commands
  • CLI Commands

    This document provides a comprehensive overview of CLI commands for meshcore.at Repeaters, Room Servers, and Sensors, covering operational, configuration, and diagnostic functions.

    Read
  • Terminal Chat CLI

    Complete reference of all commands available in the MeshCore Terminal Chat CLI for device configuration and messaging.

    Read
03Protocols
  • Companion Protocol

    This document provides a comprehensive, platform-agnostic guide for communicating with MeshCore devices over Bluetooth Low Energy (BLE).

    Read
  • MeshCore KISS Modem Protocol

    This documentation describes the MeshCore KISS Modem Protocol, detailing its frame format, standard commands, MeshCore-specific extensions for cryptography and radio configuration, and data formats for off-grid communication.

    Read
04Data Formats
  • Packet Format

    Detailed specification of the MeshCore packet format including header structure, route types, payload types, path encoding, and versioning.

    Read
  • Payload Format

    This document defines the structure and content of various payload types used within MeshCore packets for off-grid communication, including advertisements, acknowledgments, messages, and control data.

    Read
  • Stats Binary Frame Structures

    Binary frame structures and parsing examples for MeshCore companion radio statistics commands including core, radio, and packet stats.

    Read
  • Number Allocations

    This document provides a comprehensive list of unique numbers and identifiers used across various MeshCore protocol payloads, detailing ranges for different applications and development stages.

    Read
05Hardware
  • nRF52 Power Management

    Comprehensive documentation of MeshCore's nRF52 power management module for battery protection, boot lockout, voltage wake, and shutdown reason tracking.

    Read