Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
816d4e2
Update faq.md
silverphish-io Sep 25, 2025
4e886bf
Typo fix in faq and payloads
silverphish-io Sep 25, 2025
c8a6bcf
Update README.md
ripplebiz Sep 28, 2025
3dc04de
Merge pull request #837 from silverphish-io/typo-fix
liamcottle Sep 28, 2025
f594f2c
Update faq.md
LitBomb Sep 30, 2025
86225cd
Merge pull request #869 from LitBomb/patch-19
ripplebiz Oct 1, 2025
6ee0b85
Fix debug log: use c->extra.room.push_failures instead of non-existen…
Oct 1, 2025
f5f5886
Merge branch 'dev'
Oct 2, 2025
3e3fa5b
trim trailing whitespace, clarify repeater gps, remove outdated instr…
tekstrand Oct 4, 2025
da5dbcd
Merge pull request #871 from spacepc-de/fix-debug-log-field
ripplebiz Oct 6, 2025
b2dcb06
Merge pull request #809 from tekstrand/fixup
liamcottle Oct 18, 2025
8b68b5a
Update README.md (RAK boards don't need pio patch)
fdlamotte Nov 12, 2025
9405e8b
Merge branch 'dev'
Nov 13, 2025
6d32193
Merge branch 'dev'
Nov 30, 2025
cae37d8
Update faq.md
LitBomb Dec 8, 2025
1f5659d
Update faq.md
LitBomb Dec 8, 2025
922e378
Merge pull request #1192 from LitBomb/patch-20
ripplebiz Dec 10, 2025
2bcc9c1
Update faq.md
mattzzw Dec 14, 2025
2228214
Merge pull request #1216 from mattzzw/main
liamcottle Dec 15, 2025
27c92d2
Update FAQ with new MeshCore applications and tx power settings for a…
LitBomb Dec 22, 2025
9b08a9b
Merge pull request #1260 from LitBomb/patch-21
ripplebiz Dec 29, 2025
a93527a
fix Station G2 output dBm typo
LitBomb Jan 3, 2026
6b52fb3
Merge pull request #1310 from LitBomb/patch-22
liamcottle Jan 3, 2026
0c2da8c
add support for mkdocs
liamcottle Jan 28, 2026
a87c0fe
separate table of contents
liamcottle Jan 28, 2026
132c896
add workflow to build and deploy docs to github pages
liamcottle Jan 28, 2026
c35c196
add docs branch for testing
liamcottle Jan 28, 2026
706b5a3
allow manual deploy
liamcottle Jan 28, 2026
e738a74
Merge branch 'dev'
Jan 29, 2026
6fba184
Sensecap solar node GPS
dowjames Jan 29, 2026
b9942bd
add mqtt option for Heltec V3 and V4
dowjames Jan 29, 2026
b8d6c32
add mqtt option for Heltec V3 and V4
dowjames Jan 29, 2026
2ffbf9a
rebase main
dowjames Jan 29, 2026
2eb1d80
Merge pull request #1579 from liamcottle/docs
liamcottle Feb 3, 2026
384e482
Create CNAME
liamcottle Feb 3, 2026
4af31e5
refactor documentation
liamcottle Feb 3, 2026
cd8d2fd
Merge pull request #1583 from liamcottle/docs/migrate
liamcottle Feb 3, 2026
dccdc4d
Fix URLs
djp3 Feb 4, 2026
10067ad
Merge pull request #1590 from djp3/main
liamcottle Feb 4, 2026
6564bbd
migrate docs build script so cname survives
liamcottle Feb 8, 2026
85aa052
only deploy docs from main branch
liamcottle Feb 8, 2026
e812632
Merge pull request #1619 from liamcottle/main
liamcottle Feb 8, 2026
4224ddf
refactor packet format docs
liamcottle Feb 8, 2026
246d681
Merge pull request #1678 from liamcottle/main
liamcottle Feb 12, 2026
93ebde3
Merge branch 'meshcore-dev:main' into main
dowjames Feb 12, 2026
5170cef
fix ikoka handheld variant
dowjames Feb 12, 2026
c57e0c7
update/fix ikoka handheld
dowjames Feb 14, 2026
5ed92af
Merge branch 'main' of https://github.com/dowjames/MeshCore
dowjames Feb 14, 2026
f1b57fe
add 33dbm companion builds
dowjames Feb 14, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Build and deploy Docs site to GitHub Pages

on:
workflow_dispatch:
push:
branches:
- main

permissions:
contents: write

jobs:
github-pages:
runs-on: ubuntu-latest
steps:

- name: Checkout Repo
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
ruby-version: 3.x

- name: Build
run: |
pip install mkdocs-material
mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
cname: docs.meshcore.nz
publish_dir: ./site
publish_branch: 'gh-pages'
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.meshcore.nz
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,10 @@ Here are some general principals you should try to adhere to:

There are a number of fairly major features in the pipeline, with no particular time-frames attached yet. In very rough chronological order:
- [X] Companion radio: UI redesign
- [ ] Repeater + Room Server: add ACL's (like Sensor Node has)
- [ ] Standardise Bridge mode for repeaters
- [X] Repeater + Room Server: add ACL's (like Sensor Node has)
- [X] Standardise Bridge mode for repeaters
- [ ] Repeater/Bridge: Standardise the Transport Codes for zoning/filtering
- [ ] Core + Repeater: enhanced zero-hop neighbour discovery
- [X] Core + Repeater: enhanced zero-hop neighbour discovery
- [ ] Core: round-trip manual path support
- [ ] Companion + Apps: support for multiple sub-meshes (and 'off-grid' client repeat mode)
- [ ] Core + Apps: support for LZW message compression
Expand All @@ -113,12 +113,3 @@ There are a number of fairly major features in the pipeline, with no particular
- Report bugs and request features on the [GitHub Issues](https://github.com/ripplebiz/MeshCore/issues) page.
- Find additional guides and components on [my site](https://buymeacoffee.com/ripplebiz).
- Join [MeshCore Discord](https://discord.gg/BMwCtwHj5V) to chat with the developers and get help from the community.

## RAK Wireless Board Support in PlatformIO

Before building/flashing the RAK4631 targets in this project, there is, unfortunately, some patching you have to do to your platformIO packages to make it work. There is a guide here on the process:
[RAK Wireless: How to Perform Installation of Board Support Package in PlatformIO](https://learn.rakwireless.com/hc/en-us/articles/26687276346775-How-To-Perform-Installation-of-Board-Support-Package-in-PlatformIO)

After building, you will need to convert the output firmware.hex file into a .uf2 file you can copy over to your RAK4631 device (after doing a full erase) by using the command `uf2conv.py -f 0xADA52840 -c firmware.hex` with the python script available from:
[GitHub: Microsoft - uf2](https://github.com/Microsoft/uf2/blob/master/utils/uf2conv.py)

14 changes: 14 additions & 0 deletions docs/_assets/meshcore_tm.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/_stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:root {
--md-primary-fg-color: #1F2937;
--md-primary-fg-color--light: #1F2937;
--md-primary-fg-color--dark: #1F2937;
--md-accent-fg-color: #1F2937;
}

/* hide git repo version */
.md-source__fact--version {
display: none;
}

/* underline links */
.md-typeset a {
text-decoration: underline;
}
4 changes: 3 additions & 1 deletion docs/cli_commands.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# MeshCore Repeater & Room Server CLI Commands
# CLI Commands

This document provides an overview of CLI commands that can be sent to MeshCore Repeaters, Room Servers and Sensors.

## Navigation

Expand Down
Loading