Documentation
The MeshCore documentation, simplified for an easy start. Content is kept in sync automatically with the official docs (docs.meshcore.io).
-
Introduction
Welcome page for the official MeshCore documentation with quick-start links to FAQs, CLI commands, protocols, and more.
Read -
Frequently Asked Questions (FAQ)
Comprehensive FAQ covering MeshCore introduction, setup, server administration, T-Deck usage, general concepts, troubleshooting, and firmware updates.
Read -
QR Codes
Overview of the QR code formats the MeshCore app uses to share channels and contacts.
Read -
Local Documentation
Instructions for building and viewing the MeshCore documentation locally using MkDocs.
Read
-
CLI Commands
Complete reference of CLI commands for MeshCore Repeaters, Room Servers and Sensors, covering operation, statistics, logging, configuration and regions.
Read -
Terminal Chat CLI
Complete reference of all commands available in the MeshCore Terminal Chat CLI for device configuration and messaging.
Read
-
Companion Protocol
Complete technical reference for the MeshCore Companion Protocol used to communicate with MeshCore devices over Bluetooth Low Energy (BLE).
Read -
KISS Modem Protocol
Complete specification of the MeshCore KISS modem protocol including frame format, standard commands, SetHardware extensions, cryptographic operations, and data formats.
Read
-
Packet Format
Detailed specification of the MeshCore packet format including header structure, route types, payload types, path encoding, and versioning.
Read -
Payload Format
Detailed specification of all MeshCore payload types including node advertisements, acknowledgements, messages, group datagrams, 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
Reference of unique number and identifier allocations used in MeshCore protocol payloads, including group data-type ranges.
Read