Skip to content

Commit c244eff

Browse files
authored
Revise Halo and Keymind settings documentation
Updated settings and examples for Halo and Keymind configuration, including changes to retry settings and prefix handling.
1 parent b475bde commit c244eff

1 file changed

Lines changed: 10 additions & 37 deletions

File tree

docs/halo_keymind_settings.md

Lines changed: 10 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ This file covers only CLI settings added by the Halo or Keymind branches. Use
55

66
## Quick Start
77

8-
Use this baseline when bringing a Halo or Keymind repeater onto the network:
98

109
```text
1110
set retry.preset rooftop
@@ -26,17 +25,7 @@ get flood.retry.prefixes
2625
get flood.retry.ignore
2726
```
2827

29-
Use prefixes from debug logs such as `path=7773D0>BEEBB0` or `heard=C7618C`. Prefix lists are comma-separated hex values, for example `71CE82,C7618C`.
30-
31-
## Prefix Worksheet
32-
33-
Keep Halo and Keymind prefixes in one place before programming buckets or ignore lists.
34-
35-
| Network | Prefix | Node or site | Use | Notes |
36-
| --- | --- | --- | --- | --- |
37-
| Halo | `A1B2C3` | example remote relay | bucket/target | Replace with real prefix |
38-
| Keymind | `71CE82` | example observed relay | ignore/target | Replace with real prefix |
39-
| Keymind | `C7618C` | example observed relay | ignore/target | Replace with real prefix |
28+
Use prefixes from the analyzer or neighbors list or `get recent.repeater` after the repeater has been online for a few hours.
4029

4130
## Common Examples
4231

@@ -47,21 +36,23 @@ set flood.retry.advert off
4736
get flood.retry.advert
4837
```
4938

50-
Ignore a relay as a successful flood retry echo:
39+
Ignore a repeater as a successful flood retry echo:
40+
Use this if you have a car repeater and a house repeater; have the house ignore the car.
5141

5242
```text
5343
set flood.retry.ignore 71CE82,C7618C
5444
get flood.retry.ignore
5545
```
5646

57-
Only accept specific downstream relays as flood retry success:
47+
Only accept specific downstream relays as flood retry success:
48+
You're in a hole and need to hit a mountain top repeater to get out; keep trying till one you see one of these send out your packet.
5849

5950
```text
60-
set flood.retry.prefixes BEEBB0,425E5C
51+
set flood.retry.prefixes A58296,860CCA,425E5C
6152
get flood.retry.prefixes
6253
```
6354

64-
Bridge two groups of repeaters:
55+
Bridge two groups of repeaters:
6556

6657
```text
6758
set flood.retry.bridge on
@@ -102,7 +93,7 @@ get recent.repeater 2
10293
Seed or correct a prefix:
10394

10495
```text
105-
set recent.repeater A1B2C3 -8.5
96+
set recent.repeater A1B2C3 8.5
10697
```
10798

10899
Rows are sorted by prefix width, then SNR. A full direct retry failure lowers
@@ -167,7 +158,7 @@ The shared retry preset sets these flood defaults:
167158
| `rooftop` | `3` | `2` |
168159
| `mobile` | `3` | `1` |
169160

170-
Example for Keymind path-gated retry:
161+
Example for path-gated retry:
171162

172163
```text
173164
set retry.preset rooftop
@@ -176,23 +167,6 @@ set flood.retry.advert off
176167
set flood.retry.ignore 71CE82,C7618C
177168
```
178169

179-
Example for Halo targeted retry:
180-
181-
```text
182-
set flood.retry.bridge off
183-
set flood.retry.prefixes A1B2C3,D4E5F6
184-
set flood.retry.ignore none
185-
```
186-
187-
Example for Halo/Keymind bridge retry:
188-
189-
```text
190-
set flood.retry.bridge on
191-
set flood.retry.bucket 1 A1B2C3,D4E5F6
192-
set flood.retry.bucket 2 71CE82,C7618C
193-
set flood.retry.advert off
194-
```
195-
196170
## North South Buckets
197171

198172
Buckets describe groups of repeaters on different sides of this relay. Bucket
@@ -302,7 +276,6 @@ set direct.retry.count 4
302276
If retries are too sparse:
303277

304278
```text
305-
set retry.preset rooftop
306-
set flood.retry.count 3
279+
set flood.retry.count 7
307280
set flood.retry.path 2
308281
```

0 commit comments

Comments
 (0)