Commit Graph

230 Commits

Author SHA1 Message Date
Jakub
fb700bbaad docs+ci: pre-merge polish — README, doc accuracy, workflow
README:
- Fix typo "offical" → "official"
- File names in Firmware Variants table now match workflow output
  (solo-<version>-oled.uf2 / solo-<version>-eink.uf2)
- Un-comment the E-ink Display section (now fully supported)
- Clock Screen: "sensor values" → "data fields" (covers Batt%, Nodes, Msgs)
- Tools Screen: mention nearby nodes and auto-advert in the highlight
- Promote Screenshot Tool to its own top-level section (was buried under
  Contributing); fix `uv run tools/screenshot.py` invocation path

Docs:
- favourites_dial: document the 3rd pin-picker tier (all chat contacts
  fallback) added in 0e0e5b93
- clock_screen: Altitude source clarified — onboard sensor (GPS or
  barometric), not always GPS
- message_screen: blank lines around image tables that were inlined

Code:
- UITask.cpp: rename leftover plus_y/plus_label locals to solo_y/solo_label
  in the splash-screen Solo banner

Workflow:
- workflow_dispatch builds previously labelled firmware with the branch
  name (GITHUB_REF_NAME). Resolve BUILD_VERSION to the tag when run on a
  tag push, else dev-<short-sha> so manual runs produce
  solo-dev-abc1234-oled.uf2 etc.

Cleanup:
- remove stray docs/solo_features/settings_screen/set_scr_1_eink copy.png

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-29 12:46:29 +02:00
Jakub
c7009140ce refactor: rename firmware from Plus to Solo
- FIRMWARE_VERSION: v1.15-plus.1 → v1.15-solo.1
- FIRMWARE_PLUS_BUILD → FIRMWARE_SOLO_BUILD in all platformio.ini and UITask.cpp
- docs/plus_features/ → docs/solo_features/ (all sub-docs moved)
- README: update all doc links plus new Documentation section
- GitHub Actions: extract GIT_TAG_VERSION in each build job (was missing,
  causing empty FIRMWARE_VERSION in builds); rename output files to
  solo-VERSION-oled.uf2 / solo-VERSION-eink.uf2; release title → "Solo VERSION"

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-29 12:25:34 +02:00
Jakub
df32f47942 docs: add settings_screen.md — full options with tables and e-ink notes
Tables for all seven sections (Display, Sound, Home Pages, Radio, System,
Contacts, Messages) with values, LEFT/RIGHT vs Enter interaction, and
e-ink-only flags. Notes: buzzer Auto mode, battery % anchor from low_batt,
Melody 1/2 link to Ringtone Editor, placeholder support in quick replies.
2026-05-29 11:26:37 +02:00
Jakub
096b6720b6 docs: rewrite favourites_dial.md — layout, navigation, badges, pin/unpin
- Describe 2×3 portrait vs 3×2 landscape grid layout
- Navigation: edge keys fall through to page nav
- Unread badge detail (ellipsis + badge coexistence)
- (gone) label for removed contacts
- Two pinning paths: empty tile picker and DM context menu
- Pin picker order: favourited contacts first, then recent DMs
- Auto-move when contact already pinned elsewhere
- Unpin via DM context menu
- Reordering via Settings › Home Pages
2026-05-29 10:45:09 +02:00
Jakub
57ac1b42b2 corrected readme path 2026-05-29 10:07:03 +02:00
Jakub
ab396eb7a1 Added eink screenshot variants 2026-05-29 10:04:05 +02:00
Jakub
7243793f9b Message screen 2026-05-29 09:51:47 +02:00
Jakub
6ce67b80cf docs: expand message_screen.md — all options, context menus, placeholders
- Describe DM/Channels/Rooms mode-select
- Describe MSG_PICK flow (keyboard vs quick replies Q1-Q10)
- Complete placeholder table — remove {batt} (shows in picker only
  when a voltage sensor is connected, not from board battery)
- Separate contact and channel context menus with full item tables
- Document LEFT/RIGHT cycling for Notif/Melody/Fav
- Describe Pin to dial with slot picker detail
- Clarify short Enter (fullscreen) vs Hold Enter (context menu)
- Add fullscreen navigation and scroll description
2026-05-29 09:41:35 +02:00
Sefinek
15ae641119 docs: fix minor typos in README and terminal_chat_cli 2026-05-28 16:38:15 +02:00
Sefinek
2adea02e9c docs: fix broken and misaligned tables 2026-05-28 15:15:47 +02:00
Sefinek
7937b43b49 docs: remove duplicate radio.rxgain entry and fix hardware note 2026-05-28 14:52:00 +02:00
Sefinek
bbe41eb375 fix: rename CMD_DEVICE_QEURY to CMD_DEVICE_QUERY 2026-05-28 14:39:12 +02:00
Sefinek
888ad4589c docs: fix typos, grammar and Wi-Fi capitalisation across docs 2026-05-28 14:23:31 +02:00
MarekZegare4
149693c928 docs refactor 2026-05-28 10:54:09 +02:00
ripplebiz
e251dc1659 Merge pull request #2540 from agessaman/feat/regions-quick-loasd
Add bulk region hierarchy command to CLI
2026-05-23 18:37:28 +10:00
agessaman
1296aa7792 Refactor region def with helpers, refine docs
Extract the inline cursor-walk in handleRegionCmd into file-local
helpers (skipSpaces, rtrimSpaces, takeToken, splitNameJump,
processRegionDefSegment), grouped immediately above the consumer.
Behavior is identical; addresses PR #2540 review feedback on
readability.

Tighten the region def docs: collapse five Note callouts into three
grouped paragraphs (Behavior / Existing regions / Limits), add a
case-sensitivity caveat plus an error example, note the cursor reset
between split commands, and use generic placeholder names.
2026-05-21 19:25:01 -07:00
agessaman
f3c6c34883 Update CLI command from region bulk to region def 2026-05-16 10:47:51 -07:00
ViezeVingertjes
79caba5bab Document HW_ERR_TX_BUSY in KISS modem protocol 2026-05-16 11:32:33 +02:00
AI7NC
16cb6d518f Update cli_commands.md to include 'ver'
Include the 'ver' command for retrieving the firmware version
2026-05-12 12:42:33 -07:00
agessaman
19f950018c Add bulk region hierarchy command to CLI
Add a new command `region bulk` for defining region hierarchies in a single line. This command allows users to create multiple regions in a single message. Updated the documentation to include usage examples and detailed parameter descriptions.
2026-05-12 12:08:03 -07:00
ripplebiz
f9ddd9da72 Merge pull request #2445 from kizniche/update-docs-txdelay-rxdelay
Docs: Add explanatory notes for txdelay, direct.txdelay, and rxdelay
2026-05-06 14:37:36 +10:00
Avi0n
0be082b5f9 fix typos 2026-04-30 14:21:26 -07:00
Kyle
293a8a9a84 docs: add explanatory notes for txdelay, direct.txdelay, and rxdelay CLI commands 2026-04-29 14:10:13 -04:00
Liam Cottle
470ad43313 Merge pull request #2392 from zjs81/meshcore_open_data_types
Introduce DataType Definitions for Meshcore Open
2026-04-28 15:42:03 +12:00
zjs81
9c8eb301a4 Clarify path length semantics and data handling in inbound group datagrams 2026-04-27 10:49:55 -07:00
zjs81
b6d0b7a5dd Refine data type definitions and update registration process in documentation 2026-04-27 10:22:17 -07:00
Liam Cottle
03a13aed30 Merge pull request #2413 from keithtweed/patch-1
Update script link in FAQ 4.7 to the repo of the fork
2026-04-27 14:17:19 +12:00
Keith Tweed
b948369d71 Update script link in FAQ 4.7 2026-04-26 19:51:33 -06:00
uncle lit
34db93150a Removed links to outdated resources and links
Removed links to outdated resources and links
2026-04-26 18:35:02 -07:00
zjs81
b705d5489f Update companion protocol documentation and enhance data type definitions for clarity 2026-04-24 04:24:20 -07:00
liamcottle
ecd0cfc1c1 update discord links 2026-04-24 15:57:34 +12:00
Scott Powell
dee3e26ac0 Merge branch 'dev'
# Conflicts:
#	docs/faq.md
2026-04-19 11:35:03 +10:00
Liam Cottle
acdb41fcf9 Merge pull request #2103 from robekl/docs-radio-rxgain
docs: add radio.rxgain command reference
2026-04-18 19:05:43 +12:00
Liam Cottle
77d737beb9 Merge pull request #2323 from txkbaldlaw/updated-companion-dfu-from-mt
Add support for Companion BLE OTA updates on nRF devices
2026-04-18 12:17:16 +12:00
txkbaldlaw
96a16c238a Additional Update to FAQs regarding Companion OTA 2026-04-17 16:17:12 -05:00
txkbaldlaw
4f9764b1b4 Update FAQ to include Companion OTA DFU updates 2026-04-17 10:56:51 -05:00
Scott Powell
d7a3d41843 Merge branch 'default-scope' into dev 2026-04-17 16:30:19 +10:00
Scott Powell
d3ba89c8bb * doco: "region default" 2026-04-17 13:49:57 +10:00
Liam Cottle
7e4d5f723a Merge pull request #2102 from robekl/docs-gps-output-format
docs: align gps output description with CLI
2026-04-13 01:51:51 +12:00
Liam Cottle
bfd4800f59 Merge pull request #2176 from jschrempp/patch-1
Update RAK 4631 entry in FAQ on new bootloader - removed "see note"
2026-04-09 01:47:50 +12:00
liamcottle
9ec08228e5 update faq 2026-04-05 22:04:36 +12:00
liamcottle
a9b55f58f1 update neighbor.remove docs 2026-04-02 23:24:39 +13:00
Liam Cottle
73fc967388 Merge pull request #2172 from LitBomb/patch-24
add multibyte FAQ, reference awesome-meshcore community projects, minor changes
2026-04-01 22:16:02 +13:00
uncle lit
633db082d1 fixed typos and refined multibyte sections.
fixed typos and refined multibyte sections.
2026-03-31 12:22:11 -07:00
Liam Cottle
856df241ee Merge pull request #2138 from MGJ520/dev_GAT562_Mesh_Watch13
Support for GAT562 Mesh Watch13 device
2026-03-31 21:54:38 +13:00
liamcottle
30963231ce update docs logo 2026-03-31 00:51:15 +13:00
Scott Powell
efc875b1b6 * more notes about number_allocations 2026-03-30 13:53:16 +11:00
Scott Powell
6fb8e60b5f * number_allocations.md data-type range changes 2026-03-30 11:53:27 +11:00
uncle lit
ea6ec53709 Fix TOC insertion by Markdown All in One VS Code extension
Fixed an extra TOC jump link inserted by VSCode Markdown All in One VS Code extension.
2026-03-29 16:22:41 -07:00
Scott Powell
515af35b13 * docs changes for PAYLOAD_TYPE_GRP_DATA 2026-03-29 06:33:35 +11:00