Commit Graph
240 Commits
Author SHA1 Message Date
Florent 6b34ae96df gps: Rework the CLI
- more consistency with other cli commands
- new format for gps fix
- gps format accepts postfix (s/m/d/h)
- documentation
2026-11-08 08:47:35 -04:00
Florent 47959b8960 gps: fix_stats command 2026-11-08 08:47:34 -04:00
Florent e58be9ab11 gps: cache the last fix in LocationProvider (isValid vs hasValidFix), fix and status commands 2026-11-08 08:47:34 -04:00
Florent 1d88a709bd ui: add some parameters to the cli (mostly regarding eink behaviour) 2026-10-29 08:34:41 -04:00
quyenlt298 f7b2acf2a0 Add Nelos allocation for GroupData 2026-10-07 13:09:36 +07:00
Blake Latchford e1877c015b Constrain agc.reset.interval and allow intervals > 255s 2026-09-21 12:26:36 -04:00
ripplebiz 191e5ee2f7 Merge pull request #3402 from meshcore-dev/sensor-improvements
Sensor improvements
2026-09-21 19:03:18 +10:00
Scott Powell b074e4f992 * request payload doco 2026-09-13 11:40:25 +10:00
Robert Ekl 1d87776c02 docs: update stale repo URLs and build recipe
The project moved to meshcore-dev/meshcore, but two links still pointed at
ripplebiz/MeshCore: the GitHub Issues link in README and the git clone in the
FAQ build instructions.

Also fixes the FAQ build recipe:
- `pio run -e RAK_4631_Repeater` does not exist; the env is spelled
  RAK_4631_repeater (variants/rak4631/platformio.ini:40).
- LORA_FREQ was given as 867.5; the default in [arduino_base] is 869.618
  (platformio.ini:29). Reworded to point at the flag rather than a value that
  drifts with the default preset.
- Renamed the venv so it no longer collides with the cloned directory name.

And one more env-name casing slip in the Raspberry Pi flashing instructions:
`Heltec_V3_companion_radio_ble` should be `Heltec_v3_...`. Release artifacts are
named directly from the env name (build.sh:147), and the two neighbouring
examples in the same block already use the lowercase spelling.
2026-09-02 11:38:06 -05:00
Robert Ekl c2860177dd docs: remove non-existent set dutycycle from Terminal Chat CLI
3d792e7b added get/set dutycycle to CommonCLI and updated both CLI docs, but
Terminal Chat does not use CommonCLI -- simple_secure_chat/main.cpp:479-507 has
its own `set` handler supporting only af, name, lat, lon, tx and freq. Typing
`set dutycycle` there returns "ERROR: unknown config".

Restores `set af` as the documented command, points readers at cli_commands.md
for the roles that do have dutycycle, and documents `help`
(simple_secure_chat/main.cpp:510), which the client implements but the doc
never listed.
2026-09-02 11:38:06 -05:00
Robert Ekl e98254afdc docs: correct pwrmgt CLI behaviour on unsupported boards
The doc claimed every pwrmgt command except `get pwrmgt.support` returns
"ERROR: Power management not supported" when NRF52_POWER_MANAGEMENT is not
defined. `get pwrmgt.bootreason` is not inside the #ifdef (CommonCLI.cpp:787)
and answers on all boards; only pwrmgt.source and pwrmgt.bootmv are gated.
2026-09-02 11:38:06 -05:00
Robert Ekl e00f1b5451 docs: fix channel index range, secret semantics and payload limit
Three factual errors in companion_protocol.md:

- The channel-datagram payload cap was given as 163 (MAX_FRAME_SIZE - 9 when
  MAX_FRAME_SIZE was still 172). It went 172 -> 176 in 22510ab8, but simply
  updating the arithmetic to 167 would be worse than the stale value: 167 is
  only the host-frame bound (MyMesh.cpp:1265). The radio-side bound is
  MAX_GROUP_DATA_LENGTH = 184 - 16 - 3 = 165 (MeshCore.h:21, enforced at
  BaseChatMesh.cpp:544). A 166- or 167-byte payload passes the frame check,
  fails the radio check, and comes back as ERR_CODE_TABLE_FULL -- which this
  same doc describes as "retry later", so a conforming client would retry a
  permanently failing send forever. Documents 165 as the limit to enforce and
  calls out the 166-167 band explicitly.

- Channel index was documented as 0-7 throughout. The bound is
  MAX_GROUP_CHANNELS (BaseChatMesh.cpp:927,936), which is 40 on most current
  variants, 8 on some and 1 on others. Clients should read max_channels from
  byte 3 of PACKET_DEVICE_INFO instead. Index 0 is pre-populated with the
  built-in Public channel but is not reserved.

- The secret field was documented as "all zeros" for public channels. The
  firmware always hashes a real 16-byte key; the public channel ships with
  izOH6cXN6mrJ5e26oRXNcg== (companion_radio/MyMesh.cpp:111,1040). An all-zero
  secret is not a private channel and not an inert one: SHA256 over 16 zero
  bytes is a fixed global constant, giving a well-known channel with an
  all-zero AES key. searchChannelsByHash skips unnamed slots for exactly this
  reason (BaseChatMesh.cpp:392-401), but a named slot with a zero secret is
  not skipped and will absorb null-key group traffic from any node. Now
  documented as something not to do.
2026-09-02 11:38:06 -05:00
Robert Ekl f163c49339 docs: correct stale CLI default values
Five "Default:" values in cli_commands.md no longer matched the firmware:

- radio / freq: the default preset moved to EU/UK (Narrow) in e80c91eb,
  changing LORA_FREQ/BW/SF from 869.525/250/11 to 869.618/62.5/8
  (platformio.ini:29-31). No variant overrides these, and LORA_CR is 5
  on every path, so the full preset is 869.618,62.5,8,5.
- flood.advert.interval: raised to 47 hours in 3e0b9da4 for both repeater
  and room server; sensor leaves it disabled.
- advert.interval: prefs store minutes/2 and the getter doubles on read, so a
  factory-fresh node reports 2, not 0. But savePrefs() zeroes any interval
  below the 60 minute minimum (CommonCLI.cpp:162-165), and it is called from
  every `set` handler -- so the value becomes 0 as soon as the node is
  configured. Documented both states, since neither alone is the whole story.
- direct.txdelay: repeater defaults to 0.3, room server and sensor to 0.2.

Sources: platformio.ini:29-31, simple_repeater/MyMesh.cpp:893,903-904,
simple_room_server/MyMesh.cpp:650,661-662, simple_sensor/SensorMesh.cpp:716,
726-727, CommonCLI.cpp:162-165,680-681.
2026-09-02 11:31:24 -05:00
Scott Powell 5c32c46219 New TXT_TYPE_CLI_COMMAND (3) 2026-08-28 13:12:59 +10:00
ripplebiz d5949f93d8 Merge pull request #3137 from agessaman/feat/station-g3-fem-prefs
Station G3: Expose, persist, and apply FEM gain preferences
2026-08-12 16:11:23 +10:00
Scott Powell da1fc9c0e8 Merge branch 'dev'
# Conflicts:
#	docs/payloads.md
2026-08-09 15:16:48 +10:00
Adam Gessaman 5704db9f74 fix(station-g3): apply FEM PA level at TX start
PA PL1 re-targets the PA's DC-DC supply rail rather than selecting a
logic-level gain, and the serial CLI is serviced on every main-loop pass
regardless of whether a transmit is in flight. A `set radio.fem.txgain`
write could therefore move the rail mid-transmit, while the SX1262 was
still driving the PA at full input power.

Record the requested level in setPAGainEnable() and drive the pin from
setTxModeEnable(), which runs from onBeforeTransmit() ahead of
startTransmit(). The level only matters while transmitting, so deferring
costs nothing.

Document that the pref is saved immediately but applied at the next
transmit, so `get radio.fem.txgain` can lead the hardware until then.
2026-08-08 14:53:57 -07:00
agessaman 2eb7feffe0 fix(station-g3): expose FEM gain preferences 2026-08-06 15:29:14 -07:00
ripplebiz 837869fa93 Merge pull request #3004 from axhoff/agent/preserve-utf8-advert-names
Preserve UTF-8 boundaries in advert names
2026-07-30 12:59:59 +10:00
DG1TAL ae3517f480 Clarify hashtag privacy and group sender identity 2026-07-27 20:07:08 +02:00
Talia 9d2343e06f docs: increase header levels on payloads page to fix table of contents
mkdocs will only consider the first H1 (if any) and subheaders under it for the table of contents

this increases the header levels of everything below "important concepts" by 1 so that the table of contents correctly resolves them
2026-07-26 15:55:27 -07:00
Liam Cottle b057f40b53 Merge pull request #2819 from ViezeVingertjes/fix/kiss-modem-usb-backpressure
fix: prevent ESP32 KISS modem stalls under USB backpressure
2026-07-24 11:51:34 +12:00
Alexander Hoffer c5f09f2490 fix: preserve UTF-8 advert names 2026-07-20 15:47:03 +01:00
liamcottle 22b2de711c Merge remote-tracking branch 'official/main' into dev 2026-07-20 20:42:09 +12:00
ViezeVingertjes 2679fa8ebc fix: prevent ESP32 KISS modem stalls under USB backpressure
Switch ESP32-S3 KISS modem environments to HWCDC and move outbound KISS writes to a non-blocking queued frame path so loop() and TX completion keep progressing when the host reads slowly. Add native backpressure regression tests and correct the native_kiss_modem test filter so this suite runs directly with pio test.
2026-07-18 22:43:55 +02:00
Ryan Gregg 3ba5de20f6 Merge remote-tracking branch 'upstream/dev' into rak-ethernet
# Conflicts:
#	examples/companion_radio/main.cpp
2026-07-13 23:06:00 -07:00
Will Dillon 4397242114 Add StreamSensor allocation for GroupData
Adds a small allocation for groupdata packets for the Meshcore firmware for the StreamSensor product. It was previously a LoRaWAN platform, and we've moved to Meshcore.

Let me know when and how to demonstrate.
2026-07-13 05:54:31 -07:00
ripplebiz 95f3869475 Revert "Add StreamSensor allocation for GroupData" 2026-07-13 19:30:11 +10:00
Will Dillon b457f22a0a Update number_allocations.md
Adds a small allocation for groupdata packets for the Meshcore firmware for the StreamSensor product.  It was previously a LoRaWAN platform, and we've moved to Meshcore.
2026-07-09 11:43:20 -07:00
liamcottle 15e509f074 update qr code docs 2026-07-06 02:04:56 +12:00
HDDen de1ec0dbd3 Update number_allocations.md 2026-06-29 12:41:44 +03:00
HDDen 3f419b9184 Update number_allocations.md
Added Data-Type range for MeshCore Images codec (range is for small reserve to future versions)
2026-06-28 00:32:22 +03:00
Ryan Gregg 7f1ecc2045 Merge remote-tracking branch 'upstream/dev' into rak-ethernet
# Conflicts:
#	docs/faq.md
#	examples/companion_radio/main.cpp
2026-06-20 14:39:03 -07:00
Wessel Nieboer e77b6b101f Have CAD be a separate toggle (set cad on/off) 2026-06-14 15:20:58 +02:00
formtapez 5ae8c26772 fix formatting 2026-06-12 12:14:46 +02:00
formtapez b21b12ec7f added some missing CLI commands 2026-06-12 12:11:12 +02:00
Quency-D 606f8f1cc3 Merge branch 'dev' into cli-lna-command 2026-06-10 11:30:04 +08:00
Scott Powell f7f8a331cd Merge branch 'dev'
# Conflicts:
#	docs/faq.md
2026-06-06 21:12:43 +10:00
IoTThinks f74c1ab368 Change default power saving setting to 'off' 2026-06-06 11:04:36 +07:00
Scott Powell 6a1a4601ba * number allocations: Ripple range reserved 2026-06-06 12:45:35 +10:00
Sefinek 03a3cf4584 docs: fix remaining rendering issues 2026-06-03 00:38:53 +02:00
Sefinek 0b0db507e3 docs: fix remaining rendering issues 2026-06-03 00:32:25 +02:00
Sefinek 0a60cb7501 docs: fix remaining rendering issues 2026-06-03 00:28:09 +02:00
Sefinek df7aed8310 docs: fix remaining rendering issues 2026-06-03 00:24:01 +02:00
Sefinek 1ba4a45043 docs: add missing periods at sentence endings 2026-06-03 00:15:26 +02:00
Sefinek 245f60b00d docs: fix FAQ rendering 2026-06-03 00:14:29 +02:00
Sefinek 1b51cb9574 docs: fix FAQ heading capitalization 2026-06-02 23:57:50 +02:00
Sefinek de0cce9c75 docs: fix FAQ link rendering 2026-06-02 23:48:28 +02:00
Sefinek 215010901c docs: fix FAQ rendering 2026-06-02 23:35:02 +02:00
Sefinek 6ce32a42e4 docs: fix FAQ resource link rendering 2026-06-02 23:31:25 +02:00