diff --git a/README.md b/README.md index d44ba3e9c..cc2c28ec4 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,26 @@ -## About MeshCore +## Halo Keymind Cascade Branch Changes over Stock -For **1.17.1.5 USA Cascade**, start with the [release guide](docs/releases/1.17.1.5.md), -[firmware picker](docs/firmware_picker.md), and [feature switches by role](docs/role_feature_switches.md). -Use the [USB web console](https://flasher.meshcore.io/console) for the default -ASCII terminal on Full Companion, Repeater, Room Server, and Sensor images. -To connect two LoRa networks, follow the [ESP-NOW bridge setup guide](docs/espnow_bridge_setup.md). +* **Two LoRa radio settings on one device.** Alternate rx & tx between two frequencies and/or modulation settings. Choose transmission profiles per contact or channel, enable or isolate crossover traffic, schedule profiles, and use a temporary update profile alongside the normal network. Includes timing calibration and separate R2 screen pages. These are time-shared profiles on one transceiver. +* **Firmware updates over LoRa.** Update repeaters/rooms/sensors over LoRa. +* **Repeater forwarding policies.** Actions include dropping, rate limiting, assigning scopes, selecting retries, and controlling forwarding priority. Separate policies cover ordinary radio forwarding, bridges, and profile crossover. +* **Flood retries that account for network topology.** Configure retry counts, path limits, packet-type limits, target prefixes, ignored repeaters, and channel-specific eligibility. Bridge buckets keep retrying until traffic is heard on the intended sides of a relay or the retry budget expires. Qualifying echoes cancel unnecessary attempts. +* **Enhanced direct-message and direct-route retries.** Dynamic coding-rate, keep trying until echo hear. +* **Enhanced Telemetry.** Single LoRa packet supports multiple days of temperature or battery voltage or GPS history. +* **Unified Full Companion firmware.** Combines USB, BLE, WiFi, and Ethernet/serial transports in one image; with runtime controls and a LoRa firmware-serving mode. Most supported targets can operate multiple transports together; some boards have explicit transport restrictions. +* **Operational reporting and alerts.** Adds optional management reports with firmware version, bootloader version, LoRa update capabilities, uptime, and historical voltage and temperature ranges. +* **Set time using LoRa Network.** Automatically set the clock based off the LoRa network. Better than 2024. +* **Companion Bluetooth privacy and recovery improvements.** Configurable mac address policies, paired-peer stealth behavior, and changes to reconnect, subscription, and startup handling. +* **Single Key DMs.** Allow for you to send your advert in the initial DM. Makes DMing a bot/bbs/etc a lot easier if they're also running this firmware. +* **agessaman Observer - ESP32 Integrated MQTT observation.** Send directly from the node to the observer api endpoint. +* **IoTThinks PowerSaving - Broader power-saving controls.** Integrates device sleep, LoRa receive duty cycling, WiFi modem-sleep policies, and GPS acquisition/cache schedules across supported roles. These controls are independently configurable; actual savings depend on hardware and workload. + +--- + +## About MeshCore MeshCore is a lightweight, portable C++ library that enables multi-hop packet routing for embedded projects using LoRa and other packet radios. It is designed for developers who want to create resilient, decentralized communication networks that work without the internet. -## [SEARCH] What is MeshCore? +## What is MeshCore? MeshCore now supports a range of LoRa devices, allowing for easy flashing without the need to compile firmware manually. Users can flash a pre-built binary using tools like Adafruit ESPTool and interact with the network through a serial console. MeshCore provides the ability to create wireless mesh networks, similar to Meshtastic and Reticulum but with a focus on lightweight multi-hop packet routing for embedded projects. Unlike Meshtastic, which is tailored for casual LoRa communication, or Reticulum, which offers advanced networking, MeshCore balances simplicity with scalability, making it ideal for custom embedded solutions, where devices (nodes) can communicate over long distances by relaying messages through intermediate nodes. This is especially useful in off-grid, emergency, or tactical situations where traditional communication infrastructure is unavailable. @@ -19,7 +31,7 @@ MeshCore provides the ability to create wireless mesh networks, similar to Mesht > role/build matrix and setup overview. For the complete MQTT command and > broker reference, see the [MQTT Implementation Guide](./MQTT_IMPLEMENTATION.md). -## [LIGHTNING] Key Features +## Key Features * Multi-Hop Packet Routing * Devices can forward messages across multiple nodes, extending range beyond a single radio's reach. @@ -30,7 +42,7 @@ MeshCore provides the ability to create wireless mesh networks, similar to Mesht * Low Power Consumption - Ideal for battery-powered or solar-powered devices. * Simple to Deploy - Pre-built example applications make it easy to get started. -## [TARGET] What Can You Use MeshCore For? +## What Can You Use MeshCore For? * Off-Grid Communication: Stay connected even in remote areas. * Emergency Response & Disaster Recovery: Set up instant networks where infrastructure is down. @@ -38,7 +50,7 @@ MeshCore provides the ability to create wireless mesh networks, similar to Mesht * Tactical & Security Applications: Military, law enforcement, and private security use cases. * IoT & Sensor Networks: Collect data from remote sensors and relay it back to a central location. -## [ROCKET] How to Get Started +## How to Get Started - Watch the [MeshCore QuickStart Playlist](https://www.youtube.com/watch?v=iaFltojJrAc&list=PLshzThxhw4O4WU_iZo3NmNZOv6KMrUuF9) by The Comms Channel - Watch the [MeshCore Technical Presentation](https://www.youtube.com/watch?v=OwmkVkZQTf4) by Liam Cottle. @@ -61,7 +73,7 @@ For developers: The Simple Secure Chat example can be interacted with through the Serial Monitor in Visual Studio Code, or with a Serial USB Terminal on Android. -## [LIGHTNING] MeshCore Flasher +## MeshCore Flasher We have prebuilt firmware ready to flash on supported devices. @@ -71,7 +83,7 @@ We have prebuilt firmware ready to flash on supported devices. - Companion, Repeater or Room Server - Once flashing is complete, you can connect with one of the MeshCore clients below. -## [PHONE] MeshCore Clients +## MeshCore Clients **Companion Firmware** @@ -91,11 +103,11 @@ The repeater and room server firmware can be set up via USB in the web config to They can also be managed via LoRa in the mobile app by using the Remote Management feature. -## [TOOLS] Hardware Compatibility +## Hardware Compatibility MeshCore is designed for devices listed in the [MeshCore Flasher](https://meshcore.io/flasher) -## [SCROLL] License +## License MeshCore is open-source software released under the MIT License. You are free to use, modify, and distribute it for personal and commercial projects. @@ -140,7 +152,7 @@ There are a number of fairly major features in the pipeline, with no particular - [ ] Core: new framework for hosting multiple virtual nodes on one physical device - [ ] V2 protocol spec: discussion and consensus around V2 packet protocol, including path hashes, new encryption specs, etc -## [TELEPHONE] Get Support +## Get Support - Report bugs and request features on the [GitHub Issues](https://github.com/meshcore-dev/MeshCore/issues) page. - Find additional guides and components on [my site](https://buymeacoffee.com/ripplebiz).