3.3 KiB
3.3 KiB
MeshCore EastMesh Docs
MeshCore-EastMesh keeps the upstream MeshCore firmware intact and publishes four firmware tracks, depending on how the device needs to connect:
companion-wifi: use this for Wi-Fi-connected companion devices. It stays closest to upstream MeshCore and adds the EastMesh Wi-Fi rescue/configuration commands.repeater-bridge-espnow: use this when you need a plain upstream-style repeater ESP-NOW bridge without MQTT uplink or the EastMesh web panel.observer-eastmesh: use this for a Wi-Fi repeater that should publish to an MQTT broker and, on supported ESP32 boards, offer the optional local web panel for setup and troubleshooting.observer-eastmesh-bridge-espnow: use this when one repeater needs both MQTT uplink and ESP-NOW bridge duties, including bridge channel/secret controls for keeping the bridge aligned with Wi-Fi.
!!! note "Bridge tracks are local radio bridges"
The bridge tracks are for bridging two nearby repeaters that operate on different MeshCore radio configs, for example one repeater on `Australia (Narrow)` and another on `Australia (Mid)`.
They are not MQTT-over-WAN, VPN, or internet bridge releases. MQTT is still the uplink/visibility path for MQTT firmware; it is not used to tunnel mesh traffic between distant sites.
If you want guidance first, start with:
If you already know your board and just want the quickest path, skip the docs and open the flasher:
I Want To
- choose a board: start with Compare Boards
- flash firmware with guidance: start with Download and Flash Releases
- flash firmware now: open the EastMesh Flasher
- set up a repeater after flashing: use Download and Flash Releases and Use the Repeater Web Panel
- understand EastMesh CLI commands: use Custom CLI Commands
- automate or script against a repeater: use Use the Repeater Web API
- build firmware locally: use Build Locally With uv
End User Guides
- Compare Boards
- Download and Flash Releases
- Migration From xJARiD/MeshCore
- Use the Repeater Web Panel
- Use the Repeater Web API
- Custom CLI Commands
Developer Notes
Current Scope
This docs site only covers the EastMesh-specific pieces in this repository.
For general MeshCore behaviour, radio operation, and upstream firmware concepts, refer to the upstream project:
Australian Regional References
These references are community-maintained rather than official project documentation, but they are still useful for Australian regional setup notes, local conventions, and area-specific MeshCore references.