Compare commits
7 Commits
advert_int
...
main-integ
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f8f9cddb47 | ||
|
|
6b52fb3230 | ||
|
|
a93527a474 | ||
|
|
9b08a9bd93 | ||
|
|
27c92d2fe9 | ||
|
|
2228214ded | ||
|
|
2bcc9c10d2 |
36
docs/faq.md
36
docs/faq.md
@@ -67,8 +67,10 @@ author: https://github.com/LitBomb<!-- omit from toc -->
|
||||
- [5.14.5. meshcore.js](#5145-meshcorejs)
|
||||
- [5.14.6. pyMC\_core](#5146-pymc_core)
|
||||
- [5.14.7. MeshCore Packet Decoder](#5147-meshcore-packet-decoder)
|
||||
- [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-clientt-applications-for-windows-or-mac)
|
||||
- [5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?](#516-q-are-there-any-document-that-compares-meshcore-with-other-lora-systems)
|
||||
- [5.14.8. meshcore-pi](#5148-meshcore-pi)
|
||||
- [5.14.9. pyMC\_Repeater](#5149-pymc_repeater)
|
||||
- [5.15. Q: Are there client applications for Windows or Mac?](#515-q-are-there-client-applications-for-windows-or-mac)
|
||||
- [5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?](#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems)
|
||||
- [6. Troubleshooting](#6-troubleshooting)
|
||||
- [6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago.](#61-q-my-client-says-another-client-or-a-repeater-or-a-room-server-was-last-seen-many-many-days-ago)
|
||||
- [6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed.](#62-q-a-repeater-or-a-client-or-a-room-server-i-expect-to-see-on-my-discover-list-on-t-deck-or-contact-list-on-a-smart-device-client-are-not-listed)
|
||||
@@ -86,6 +88,8 @@ author: https://github.com/LitBomb<!-- omit from toc -->
|
||||
- [7.4. Q: are the MeshCore logo and font available?](#74-q-are-the-meshcore-logo-and-font-available)
|
||||
- [7.5. Q: What is the format of a contact or channel QR code?](#75-q-what-is-the-format-of-a-contact-or-channel-qr-code)
|
||||
- [7.6. Q: How do I connect to the companion via WIFI, e.g. using a heltec v3?](#76-q-how-do-i-connect-to-the-companion-via-wifi-eg-using-a-heltec-v3)
|
||||
- [7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with a EByte E22-900M30S or a E22-900M33S module, what should their transmit power be set to?](#77-q-i-have-a-station-g2-or-a-heltec-v4-or-an-ikoka-stick-or-a-radio-with-a-ebyte-e22-900m30s-or-a-e22-900m33s-module-what-should-their-transmit-power-be-set-to)
|
||||
- [| | High Output | 22 dBm | 28 dBm | |](#--high-output--22-dbm--28-dbm--)
|
||||
|
||||
## 1. Introduction
|
||||
|
||||
@@ -269,7 +273,7 @@ You can get the latitude and longitude from Google Maps by right-clicking the lo
|
||||
**A:** You can issue these commands to get or set a repeater's private key using a USB serial connection.
|
||||
|
||||
`get prv.key` to print a repeater's private key on the serial console
|
||||
`set prv.key <hex>` to set a repeater's private key on the serila console
|
||||
`set prv.key <hex>` to set a repeater's private key on the serial console
|
||||
|
||||
Reboot the repeater after `set prv.key <hex>` command for the new private key to take effect.
|
||||
|
||||
@@ -636,6 +640,14 @@ https://github.com/rightup/pyMC_core
|
||||
A TypeScript library for decoding MeshCore mesh networking packets with full cryptographic support. Uses WebAssembly (WASM) for Ed25519 key derivation through the orlp/ed25519 library. It powers the [MeshCore Packet Analyzer](https://analyzer.letsme.sh/packets).
|
||||
https://github.com/michaelhart/meshcore-decoder
|
||||
|
||||
#### 5.14.8. meshcore-pi
|
||||
meshcore-pi is another Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI or GPIO.
|
||||
https://github.com/brianwiddas/meshcore-pi
|
||||
|
||||
#### 5.14.9. pyMC_Repeater
|
||||
pyMC_Repeater is a repeater daemon in Python built on top of the [`pymc_core`](#5146-pymc_core) library.
|
||||
https://github.com/rightup/pyMC_Repeater
|
||||
|
||||
|
||||
### 5.15. Q: Are there client applications for Windows or Mac?
|
||||
**A:** Yes, the same iOS and Android client is also available for Windows and Intel Mac (sorry, not available for ARM-based Mac yet). You can find them together with the Android APK here:
|
||||
@@ -790,4 +802,22 @@ where `&type` is:
|
||||
WiFi firmware requires you to compile it yourself, as you need to set the wifi ssid and password.
|
||||
Edit WIFI_SSID and WIFI_PWD in `./variants/heltec_v3/platformio.ini` and then flash it to your device.
|
||||
|
||||
### 7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with a EByte E22-900M30S or a E22-900M33S module, what should their transmit power be set to?
|
||||
**A:**
|
||||
For companion radios, you can set these radios' transmit power in the smartphone app. For repeater and room server radios, you can set their transmit power using the command line command `set tx`. You can get their current value using command line comand `get tx`
|
||||
|
||||
|
||||
> ### ⚠️ **WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.**
|
||||
|
||||
| Device / Model | Region / Description | In-App Setting (dBm) | Target Radio Output | Notes |
|
||||
| :--- | :--- | :--- | :--- | :--- |
|
||||
| **Station G2** <br> [Reference](https://wiki.uniteng.com/en/meshtastic/station-g2) | US915 Max Output | 19 dBm | 36.5 dBm (4.46W) | |
|
||||
| | US915 Recommended Max | 16 dBm | 35 dBm (3.16W) | 1dB compression point |
|
||||
| | EU868 Recommended Max | 15 dBm | 34.5 dBm (2.82W) | 1dB compression point |
|
||||
| | US915 1W Output | 10 dBm | 1W | |
|
||||
| | EU868 1W Output | 9 dBm | 1W | |
|
||||
| **Ikoka Stick E22-900M30S** | 1W Model | 19 dBm | 1W | **DO NOT EXCEED** (Risk of burn out) |
|
||||
| **Ikoka Stick E22-900M33S** | 2W Model | 9 dBm | 2W | **DO NOT EXCEED** (Risk of burn out) |
|
||||
| **Heltec V4** | Standard Output | 10 dBm | 22 dBm | |
|
||||
| | High Output | 22 dBm | 28 dBm | |
|
||||
---
|
||||
|
||||
@@ -697,7 +697,7 @@ MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondCloc
|
||||
_prefs.cr = LORA_CR;
|
||||
_prefs.tx_power_dbm = LORA_TX_POWER;
|
||||
_prefs.advert_interval = 1; // default to 2 minutes for NEW installs
|
||||
_prefs.flood_advert_interval = 48; // 48 hours, minimum is 12h
|
||||
_prefs.flood_advert_interval = 12; // 12 hours
|
||||
_prefs.flood_max = 64;
|
||||
_prefs.interference_threshold = 0; // disabled
|
||||
|
||||
@@ -787,7 +787,7 @@ void MyMesh::updateAdvertTimer() {
|
||||
}
|
||||
|
||||
void MyMesh::updateFloodAdvertTimer() {
|
||||
if (_prefs.flood_advert_interval > 12) { // schedule flood advert timer, min. 12h
|
||||
if (_prefs.flood_advert_interval > 0) { // schedule flood advert timer
|
||||
next_flood_advert = futureMillis(((uint32_t)_prefs.flood_advert_interval) * 60 * 60 * 1000);
|
||||
} else {
|
||||
next_flood_advert = 0; // stop the timer
|
||||
|
||||
@@ -612,7 +612,7 @@ MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondCloc
|
||||
_prefs.tx_power_dbm = LORA_TX_POWER;
|
||||
_prefs.disable_fwd = 1;
|
||||
_prefs.advert_interval = 1; // default to 2 minutes for NEW installs
|
||||
_prefs.flood_advert_interval = 48; // 48 hours
|
||||
_prefs.flood_advert_interval = 12; // 12 hours
|
||||
_prefs.flood_max = 64;
|
||||
_prefs.interference_threshold = 0; // disabled
|
||||
#ifdef ROOM_PASSWORD
|
||||
@@ -692,7 +692,7 @@ void MyMesh::updateAdvertTimer() {
|
||||
}
|
||||
}
|
||||
void MyMesh::updateFloodAdvertTimer() {
|
||||
if (_prefs.flood_advert_interval > 12) { // schedule flood advert timer
|
||||
if (_prefs.flood_advert_interval > 0) { // schedule flood advert timer
|
||||
next_flood_advert = futureMillis(((uint32_t)_prefs.flood_advert_interval) * 60 * 60 * 1000);
|
||||
} else {
|
||||
next_flood_advert = 0; // stop the timer
|
||||
|
||||
@@ -371,8 +371,8 @@ void CommonCLI::handleCommand(uint32_t sender_timestamp, const char* command, ch
|
||||
strcpy(reply, "OK");
|
||||
} else if (memcmp(config, "flood.advert.interval ", 22) == 0) {
|
||||
int hours = _atoi(&config[22]);
|
||||
if ((hours > 0 && hours < 12) || (hours > 48)) {
|
||||
strcpy(reply, "Error: interval range is 12-48 hours");
|
||||
if ((hours > 0 && hours < 3) || (hours > 48)) {
|
||||
strcpy(reply, "Error: interval range is 3-48 hours");
|
||||
} else {
|
||||
_prefs->flood_advert_interval = (uint8_t)(hours);
|
||||
_callbacks->updateFloodAdvertTimer();
|
||||
|
||||
56
tools/maint/README.md
Normal file
56
tools/maint/README.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# Maintenance Tools
|
||||
|
||||
This directory contains automation for managing our **Friendly Fork**. It allows us to integrate community-submitted Pull Requests from the upstream repository into our local development branches.
|
||||
|
||||
## Why this exists
|
||||
|
||||
In firmware development, critical bug fixes or hardware support often exist in the upstream "Pull Request" queue long before they are officially merged. This tool allows us to build an integrated firmware version that includes those necessary patches while remaining syncable with the official source.
|
||||
|
||||
## Usage
|
||||
|
||||
### 1. Prerequisites
|
||||
|
||||
You must have the original repository added as a remote named `upstream`:
|
||||
|
||||
```bash
|
||||
git remote add upstream https://github.com/meshcore-dev/MeshCore.git
|
||||
```
|
||||
|
||||
### 2. Basic Commands
|
||||
|
||||
**Apply specific patches:**
|
||||
To pull in PR #1338 and PR #1400 from the upstream project:
|
||||
|
||||
```bash
|
||||
./tools/maint/apply_patches.sh 1338 1400
|
||||
|
||||
```
|
||||
|
||||
**Start over (Reset):**
|
||||
To wipe the integrated branch and reset it to match the official upstream `main` branch exactly:
|
||||
|
||||
```bash
|
||||
./tools/maint/apply_patches.sh --reset
|
||||
|
||||
```
|
||||
|
||||
## Traceability
|
||||
|
||||
Every time this script runs, it updates `patch_manifest.log`. This file tracks:
|
||||
|
||||
* The date of the integration.
|
||||
* The base commit SHA we started from.
|
||||
* The specific commit SHA of every PR applied.
|
||||
|
||||
**This log is essential for debugging firmware regressions.** If the hardware fails, check the manifest to identify which experimental patch might be the cause.
|
||||
|
||||
---
|
||||
|
||||
### A Note on Merge Conflicts
|
||||
|
||||
If a PR cannot be applied automatically, the script will abort the merge. You will need to:
|
||||
|
||||
1. Manually merge the PR.
|
||||
2. Resolve the conflicts in your editor.
|
||||
3. Commit the result.
|
||||
4. Manually update the `patch_manifest.log`.
|
||||
65
tools/maint/apply_patches.sh
Executable file
65
tools/maint/apply_patches.sh
Executable file
@@ -0,0 +1,65 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Configuration
|
||||
UPSTREAM_REMOTE="upstream"
|
||||
BASE_BRANCH="main" # Change to 'master' if that's what upstream uses
|
||||
TARGET_BRANCH="main-integrated"
|
||||
MANIFEST_FILE="tools/maint/patch_manifest.log"
|
||||
|
||||
# Function to reset the branch
|
||||
reset_to_upstream() {
|
||||
echo "Warning: This will wipe all local changes on $TARGET_BRANCH."
|
||||
read -p "Are you sure you want to reset to $UPSTREAM_REMOTE/$BASE_BRANCH? (y/n) " -n 1 -r
|
||||
echo
|
||||
if [[ $REPLY =~ ^[Yy]$ ]]; then
|
||||
git fetch "$UPSTREAM_REMOTE"
|
||||
git checkout -B "$TARGET_BRANCH" "$UPSTREAM_REMOTE/$BASE_BRANCH"
|
||||
echo "--- Reset to Upstream: $(date) ---" > "$MANIFEST_FILE"
|
||||
echo "Base Commit: $(git rev-parse HEAD)" >> "$MANIFEST_FILE"
|
||||
echo "Reset successful. Branch is now clean."
|
||||
else
|
||||
echo "Reset aborted."
|
||||
fi
|
||||
}
|
||||
|
||||
# Check for reset flag
|
||||
if [[ "$1" == "--reset" ]]; then
|
||||
reset_to_upstream
|
||||
exit 0
|
||||
fi
|
||||
|
||||
# Standard PR application logic
|
||||
PR_IDS=("$@")
|
||||
if [ ${#PR_IDS[@]} -eq 0 ]; then
|
||||
echo "Usage:"
|
||||
echo " Apply PRs: $0 <PR_ID1> <PR_ID2> ..."
|
||||
echo " Reset: $0 --reset"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Ensure target branch exists and is checked out
|
||||
git checkout -B "$TARGET_BRANCH"
|
||||
|
||||
echo "--- Patch Session: $(date) ---" >> "$MANIFEST_FILE"
|
||||
|
||||
for PR in "${PR_IDS[@]}"; do
|
||||
echo "--------------------------------------"
|
||||
echo "Fetching PR #$PR..."
|
||||
|
||||
if git fetch "$UPSTREAM_REMOTE" "pull/$PR/head:PR_TEMP_FETCH"; then
|
||||
if git merge PR_TEMP_FETCH --no-edit -m "Integrate upstream PR #$PR"; then
|
||||
echo "Successfully integrated PR #$PR"
|
||||
echo "PR #$PR SHA: $(git rev-parse PR_TEMP_FETCH)" >> "$MANIFEST_FILE"
|
||||
else
|
||||
echo "Conflict in PR #$PR. Aborting merge."
|
||||
git merge --abort
|
||||
exit 1
|
||||
fi
|
||||
git branch -D PR_TEMP_FETCH
|
||||
else
|
||||
echo "Error: PR #$PR not found."
|
||||
fi
|
||||
done
|
||||
|
||||
echo "--------------------------------------"
|
||||
echo "Done. See $MANIFEST_FILE for details."
|
||||
Reference in New Issue
Block a user