MeshCore documentation

Off-grid mesh communication over LoRa radio.

Note

New here? Start with What is MeshCore? and Getting Started: the first installation in three steps. How to read this states what each section assumes and where to start.

Usage

• What is MeshCore?
• Origin and History
• Node Types
• Getting Started
• Communication
• Privacy & Security
• Practical Applications
• Hardware Overview
• Off-Grid Client Repeat Mode
• Regulations & Duty Cycle

Technical

• The MeshCore Layer Model
• From Text to Chirp
• Chirp and DeChirp Simplified
• LoRa Modulation
• MeshCore Packet Structure
• Regions and Scopes
• Regions: intent and practice
• Direct Messages
• Room Server — technical/roomserver/
  • What a Room Server Is
  • Logging In and the ACL
  • Posts and Synchronisation
  • Requests and CLI
  • Limits and Loose Ends
• Private & Public Key Encryption
• Channel Structure & PSK
• Remote Control
• Route Tracing
• Repeater TX/RX flow
• SenseCap DFU
• Higher and stronger isn't always better

Design (Node)

• Designing MeshCore
• Logical design — design/logical/
  • Roles
  • Components
  • Contracts
  • Information model
  • Variability
  • Design decisions
• Technical design — design/technical/
  • The source tree
  • The class model
  • Platform realisation
  • Radio realisation
  • The build system
  • Compile-time configuration
  • Traceability

Design (Companion)

• The companion interface
• Logical design — companion/logical/
  • Responsibilities
  • The interaction model
  • Information model
• Technical design — companion/technical/
  • The three transports
  • The frame
  • The command groups
  • Architecture of a client

Platform

• MeshCore Platforms
• The Four Platform Families
• Node Matrix
• Pin assignments — platform/pins/
  • ESP32
  • nRF52
  • RP2040
  • STM32WL

Hardware

• The Hardware of a Node
• Radio — hardware/radio/
  • The LoRa Transceiver
  • The LR2021
  • Antenna
  • Link Budget
  • Filters
• Interfaces — hardware/interfaces/
  • BLE Architecture
  • WiFi as a Companion Connection
  • USB Serial
  • The I²C Bus
  • The SPI Bus
• Peripherals — hardware/peripherals/
  • The Display
  • GPS
  • Feedback

Libraries

• Libraries in MeshCore
• Dependencies between libraries
• Library Configuration
• Core libraries — libraries/core/
  • RadioLib
  • Crypto: rweather and ed25519
  • CayenneLPP
  • RTClib
  • Melopero RV3028
  • CustomLFS
  • Adafruit LittleFS for STM32
  • SubGhz
  • ESPAsyncWebServer
  • AsyncElegantOTA
  • Wire and SPI
• Supporting libraries — libraries/other/
  • Display libraries
  • Sensor libraries
  • GPS libraries
  • Power and energy measurement
  • Peripherals
  • Utility libraries
  • Test libraries

CLI reference

• CLI reference
• Operational
• Neighbors
• Statistics
• Logging
• Info
• Radio
• System
• Routing
• ACL
• Regions
• GPS
• Sensors
• Bridge
• Power management (nRF52)
• Companion: CLI Rescue
• Ethernet

Reference

• Terminology
• References & Sources
• Links & Resources

Project

• How to read this
• About DOMCA
• GitHub Repositories
• Changes in v1.17.1
• Forks & variants — analysis on domca.nl