|
1 | 1 | # LinkSim Onboarding |
2 | 2 |
|
3 | | -## 1. Scenarios |
4 | | -- A **simulation** is your working setup: selected sites, links, and radio/model settings. |
| 3 | +## Scenarios |
| 4 | +- A **simulation** is a complete setup of sites, links, and radio/model settings. |
5 | 5 | - Open an existing simulation from **Simulation Library** or create a new one. |
6 | 6 | - Use clear names so teammates can find simulations quickly. |
7 | 7 |
|
8 | | -## 2. Sites |
| 8 | +## Sites |
9 | 9 | - Sites are physical node locations with coordinates, ground elevation, and antenna height. |
10 | 10 | - Manage your reusable site collection in **Site Library**. |
11 | | -- Add sites by coordinates, map pick, search, or Meshtastic sources. |
| 11 | +- Add sites by coordinates, map pick, search, or Meshtastic MQTT sources. |
12 | 12 | - Add sites from the library into the current simulation as needed. |
| 13 | +- Both sites and simulations can be shared with other users. |
13 | 14 |
|
14 | | -## 3. Links |
| 15 | +## Links |
15 | 16 | - A link is a **From -> To** path between two sites used for path analysis. |
16 | 17 | - Links let you compare multiple candidate paths in one simulation. |
17 | 18 | - Start with the two sites you care about most, then add relay candidate links. |
18 | 19 |
|
19 | | -## 4. Other Settings |
| 20 | +## Other Settings |
20 | 21 | - **Channel**: frequency, bandwidth, SF, coding rate, TX power, gains, cable loss. |
21 | 22 | - **Propagation model**: FSPL, TwoRay, or ITM (terrain-aware approximation). |
22 | 23 | - **Terrain**: fetch and refresh terrain before relying on pass/fail decisions. |
23 | 24 | - **RX target**: your decision threshold; pass/fail is based on this target. |
24 | 25 |
|
25 | | -## 5. Map and Plots |
26 | | -- The map shows channel/coverage overlays for the selected simulation and link. |
27 | | -- Use map controls to fit, inspect terrain, and switch visualization modes. |
28 | | -- The **path profile** shows terrain, LOS/Fresnel context, and endpoint relationship. |
29 | | -- Use overlays to find potential relay positions and validate route quality. |
| 26 | +## Map and Plots |
| 27 | +- The map can display several plot/overlay modes. Use them for different questions: |
30 | 28 |
|
31 | | -## 6. User Rights and Permissions |
| 29 | +| Plot / Overlay | What it shows | What to use it for | |
| 30 | +| --- | --- | --- | |
| 31 | +| Heatmap | Continuous RX strength estimate (dBm) across sampled area | Quick quality overview and hotspot discovery | |
| 32 | +| Bands (Contours) | Stepped strength zones (same RX model as heatmap, grouped levels) | Fast threshold-oriented planning and area segmentation | |
| 33 | +| Pass/Fail | Binary result against current RX target | Clear go/no-go checks for deployment decisions | |
| 34 | +| Relay | Best relay-candidate regions for selected From/To pair | Find where a third node could bridge weak links | |
| 35 | +| Terrain overlay | Terrain raster used by simulation in current area | Confirm what elevation input the model is actually using | |
| 36 | +| Path profile | Elevation profile + link geometry between selected endpoints | Validate LOS/Fresnel context and understand obstructions | |
| 37 | + |
| 38 | +- Practical workflow: |
| 39 | + 1. Start with **Pass/Fail** for decision clarity. |
| 40 | + 2. Switch to **Heatmap/Bands** for quality gradients. |
| 41 | + 3. Use **Relay** to locate candidate repeater sites. |
| 42 | + 4. Confirm terrain and inspect **Path profile** before finalizing. |
| 43 | + |
| 44 | +## User Rights and Permissions |
32 | 45 | - User roles: **Pending**, **User**, **Moderator**, **Admin**. |
33 | | -- Resource visibility: **Private**, **Public**, **Shared**. |
| 46 | +- Resource visibility: |
| 47 | + - **Private**: only owner/admin can view and edit. |
| 48 | + - **Public**: everyone can view; owner/moderator/admin can edit. |
| 49 | + - **Shared**: everyone can view and edit; only owner/moderator/admin can delete. |
34 | 50 | - Collaborators grant edit rights on a site or simulation. |
35 | 51 | - Moderation/admin actions are audited; use least privilege where possible. |
36 | 52 |
|
|
0 commit comments