Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,33 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
collapsed: false,
items: [
{ text: 'Connecting to the router', link: '/guide/connecting' },
{ text: 'Packages selection',
link: '/guide/packages-selection',
{ text: 'Using LimeApp',
link: '/guide/limeapp/',
collapsed: true,
items: [
{ text: 'Overview', link: '/guide/limeapp/' },
{ text: 'Accessing LimeApp', link: '/guide/limeapp/access' },
{ text: 'A tour of the menu', link: '/guide/limeapp/menu' },
{ text: 'Status', link: '/guide/limeapp/status' },
{ text: 'Alignment', link: '/guide/limeapp/alignment' },
{ text: 'Map', link: '/guide/limeapp/map' },
{ text: 'Diagnostics', link: '/guide/limeapp/diagnostics' },
{ text: 'Notes', link: '/guide/limeapp/notes' },
{ text: 'Node configuration', link: '/guide/limeapp/node-config' },
{ text: 'Network configuration', link: '/guide/limeapp/network-config' },
{ text: 'Firmware', link: '/guide/limeapp/firmware' },
{ text: 'Visit neighbor node', link: '/guide/limeapp/visit-node' },
{ text: 'Remote support', link: '/guide/limeapp/remote-support' },
{ text: 'Aligning antennas', link: '/guide/limeapp/aligning-antennas' },
]
},
{ text: 'Packages selection',
link: '/guide/packages-selection',
collapsed: true,
items: [
{ text: 'Network Profiles', link: '/guide/network-profiles' }
] },
{ text: 'Build LibreMesh',
{ text: 'Build LibreMesh',
link: '/build/',
collapsed: true,
items: [
Expand Down
7 changes: 7 additions & 0 deletions docs/guide/connecting.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,13 @@ These addresses are available as well:
- http://\[fd0d:fe46:8ce8::1\] - default anygw ipv6
- http://\[fd0d:fe46:8ce8::x\:xx\] - node default LAN `br-lan` ipv6 address

The recommended way to access the node on a LibreRouter is through the
**LimeApp** web interface that comes preinstalled. It is a friendlier
alternative to LuCI/SSH for everyday node administration and is the
default UI of LibreRouterOS. See the full
[Using LimeApp](/guide/limeapp/) guide for a tour of its features
(status, alignment, diagnostics, firmware update, etc.).

![lime-app](/lime-app.png)

## via SSH
Expand Down
24 changes: 24 additions & 0 deletions docs/guide/limeapp/access.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
outline: deep
---

# Accessing LimeApp

The most common way to reach LimeApp is from the **Wi-Fi connection** of the phone or notebook you are using.

1. Turn off the mobile data connection.
2. Connect your device to the Wi-Fi zone of the LibreRouter.
3. Open a browser (Chrome, Firefox, etc.).
4. Type [`http://minodo.info`](http://minodo.info) in the address bar.

![Accessing LimeApp from Wi-Fi](/guide/limeapp/images/access_wifi.png)

You can also reach LimeApp via a **wired connection**: plug a network cable from the LAN port of the LibreRouter (or its PoE injector) into the Ethernet port of your notebook or computer.

![Accessing LimeApp from a wired connection](/guide/limeapp/images/access_cable.png)

See also the [Connecting to the router](/guide/connecting) page for the full list of hostnames and IP addresses that can be used to reach a node.

---

> **Attribution.** Translated from [«¿Cómo acceder?»](https://conectividad.altermundi.net/documentacion/usar-limeapp1-4/como-acceder/) by [AlterMundi](https://altermundi.net/), licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
114 changes: 114 additions & 0 deletions docs/guide/limeapp/aligning-antennas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
---
outline: deep
---

# Aligning the antennas of a LibreRouter with LimeApp

Achieving the best possible alignment on a Wi-Fi link is very important for the proper functioning of the community network and its performance.

It is **strongly recommended** to aim the antennas as well as possible, even when the perceived usability of the network is acceptable to the people using it. Stacking links of insufficient quality leads to a network with problems that are hard to diagnose, or to diagnostics that cannot be trusted.

It is a low-complexity task that requires dedication, patience, and time.

## Contents

- [🙌 Recommendations before you start](#🙌-recommendations-before-you-start)
- [✅ Verify that the LibreRouters are linked](#✅-verify-that-the-librerouters-are-linked)
- [🎯 Let's align!](#🎯-let-s-align)
- [Using the Alignment tool of LimeApp](#using-the-alignment-tool-of-limeapp)
- [Going for it!](#going-for-it)
- [📌 Things to keep in mind](#📌-things-to-keep-in-mind)
- [Long links](#long-links)
- [Covering an area](#covering-an-area)

## 🙌 Recommendations before you start

To work properly, a few prerequisites and materials need to be checked:

- **Check the weather conditions in advance.** Do not work on windy, drizzly, or extremely hot/cold days.
- **Wear appropriate clothing, footwear, and safety equipment**, especially for work at dangerous heights.
- **Verify the correct installation of the node and its mounting structure.**
- Check that everything is firm, with no pendulum or rotational movement, and that the device is solidly attached to the mast. You can follow this [checklist](https://conectividad.altermundi.net/wp-content/uploads/2021/01/Montaje-Lista-de-control_sin-rulos-y-numeros-en-antenas.png).
- Whenever you are at the height of the node, take the opportunity to inspect the integrity of all its parts: connectors firmly attached, cables and enclosure in good shape, LEDs on, etc. When antennas are out of reach, this task becomes much harder. Whenever possible, place them within reach and in comfortable working positions, even if that is not the highest point.
- **Loosen the antennas a little**, but tight enough that they do not move unless you hold them. This lets you move them during alignment.
- **Confirm a clear line of sight.** The electromagnetic waves of Wi-Fi links weaken significantly when they pass through objects, trees, and other obstacles. For this reason, it is important to verify that there is a clear line of sight between the two mounting points. The [Participatory Mapping of a Free, Community Network](https://conectividad.altermundi.net/documentacion/mapeo-participativo-de-una-red-libre-y-comunitaria/) material can be very useful.
- **Analyse the possible link on a map.** Look at a satellite map in advance, draw the line, and reference the alignment with something close-by that is visible to the naked eye.
![Satellite map preview](/guide/limeapp/images/aligning_satellite_map.png)
- **Analyse the elevation profile of the terrain and assess the feasibility of the link.** In this profile, pay attention to the exact location of both antennas, the line of sight between them, the curvature of the Earth, and the Fresnel zone. There are link calculators that combine this data automatically — you only need to learn a little about how to use them. Two free options, for example, are [airLink](https://link.ui.com/) and [LigoWave](https://linkcalc.ligowave.com/Account/Login).
![Elevation profile](/guide/limeapp/images/aligning_elevation_profile.png)

## ✅ Verify that the LibreRouters are linked

- **If the LibreRouter nodes are about to be installed:** power them on beforehand to confirm they work and link correctly. Trying to align antennas that are already mounted but do not link can be very frustrating.
- **If the LibreRouter nodes are already installed:** make sure they are powered on and that LimeApp is reachable from both.

::: warning If the LibreRouter does not see any signal, or does not see the signal of the node you want to point at — i.e. it does not link to the target node:
- LimeApp reports the situation on a screen that reads «This radio is not linked to other nodes».
- Check that you are pointing correctly:
If you are aligning Antenna 1 (Radio1), make sure you are pointing at Antenna 1 of the other node. Same for Antenna 2 (Radio2). You can align 1↔1 and 2↔2 without crossing them.
![No link warning](/guide/limeapp/images/aligning_no_link_warning.png)
- Try a first *«by eye»* alignment until you obtain a link, even if the signal is poor.
- If you cannot get any link after a while, re-check that both devices power on and reach LimeApp. If the problem persists, re-evaluate the line of sight, inspect the integrity of the node parts, and/or test the devices unmounted at a short distance.
:::

## 🎯 Let's align!

### Using the Alignment tool of LimeApp

All the details about this tool are in the [Alignment](/guide/limeapp/alignment) page. Don't skip it! 🤓

1. Open [LimeApp](/guide/limeapp/access) of the base node you are working from.
2. From the menu, go to the [Alignment](/guide/limeapp/alignment) screen.
3. Pick the node you are aligning against, and open the specific, detailed information.

![Alignment tool](/guide/limeapp/images/aligning_tool.png)

The goal is to reach a value as close to **0** (zero) as possible. This value represents the quality of the link, measured in dBm (decibel-milliwatts). It is always a negative number, so -65 means a better signal than -72.

LimeApp uses the colours **green**, **yellow**, and **red** to identify whether a link signal is of good, medium, or low quality.

![Signal value colour coding](/guide/limeapp/images/aligning_signal_value.png)

✔ Treat the best value you have repeated several times as valid.
✘ Discard isolated values that represent a sudden jump in the measurement, however good they look, because they are not representative.
🟡 If the best value you can get is a medium-quality link, the community may decide that this link is necessary for the network, even if you cannot improve the signal value.
🔴 Low-quality links provide a very poor user experience and erode the social fabric of the network. It is best to refuse them.

### Going for it!

**The key is to move the antenna slowly and millimetre by millimetre**, paying attention to the change of value on the screen.

![Slow movement](/guide/limeapp/images/aligning_movement.png)

1. **Move the desired antenna horizontally ↔** until you get the best value.
2. **Do the same vertically ↕** until you reach a value that is the same as or better than the one obtained during the horizontal movement.
3. **Finally, repeat the procedure horizontally**, stopping at the best value you recorded or any improvement on it.
4. **Once the best alignment is achieved:**
- Tighten the antenna to the mast or structure, firmly, so that it does not move in the wind.
- Check that the previously achieved value does not change. It is common for tightening to cause small movements that worsen the result.
- Correct these variations as you tighten, slowly and patiently.
5. **Repeat the same task on the LibreRouter(s) at the other end of the link.**

## 📌 Things to keep in mind

### Long links

On long links, alignment is more sensitive to movement because the illumination angle widens.

![Long links](/guide/limeapp/images/aligning_long_links.png)

### Covering an area

In a mesh network, sometimes you decide to point at, or *illuminate*, an area or several nodes at once, instead of a single specific node. In that case, you can point at the most central node of the area of interest, and check that the signal level is acceptable at every node to be linked. Don't forget that all the involved nodes must use the same radio/antenna.

![Covering an area](/guide/limeapp/images/aligning_cover_area.png)

For example, in the image above, the coverage angle aims to reach nodes 1, 2, and 3 with reasonable link quality for each one:

- Node 2 has the best link quality, being at the centre of the focus.
- Nodes 1 and 3 have lower but still acceptable link quality, thanks to the aperture angle of the LibreRouter's sectorial antennas.
- More distant points, which would link with low quality, should be avoided because they hurt the overall performance of the network, like node 4 in the example.

---

> **Attribution.** Translated from [«Alinear antenas de un Equipo LibreRouter con LimeApp 1.4»](https://conectividad.altermundi.net/documentacion/usar-limeapp1-4/alinear-antenas-de-un-equipo-librerouter-con-limeapp-1-4/) by [AlterMundi](https://altermundi.net/), licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
66 changes: 66 additions & 0 deletions docs/guide/limeapp/alignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
outline: deep
---

# Alignment

The alignment screen is a tool for evaluating and improving the quality of the Wi-Fi link between the base node and one or more nodes within its range. It is used both at installation time and during diagnostics and maintenance.

- [Main screen and associated nodes](#main-screen-and-associated-nodes)
- [Viewing the alignment info of a specific link](#viewing-the-alignment-info-of-a-specific-link)
- [When no possible link is found](#when-no-possible-link-is-found)
- [When a link loses signal](#when-a-link-loses-signal)

## Main screen and associated nodes

When you open the screen, this is the main view:

![Alignment main screen](/guide/limeapp/images/alignment_radios.png)

1. Two tabs, one for each radio of the LibreRouter. The selected tab is highlighted in bold.
- **Radio 1.** This tab shows the nodes associated with this radio, which corresponds to **Antenna 1** of the device.
- **Radio 2.** This tab shows the nodes associated with this radio, which corresponds to **Antenna 2** of the device.

2. A list of the associated nodes with a brief summary.

![Node list with link quality](/guide/limeapp/images/alignment_nodes.png)

a. **The name of the node and the radio through which the base node is communicating with it.**
b. **Link-quality value.** A number that quantifies the strength of the signal, expressed in dBm (decibel-milliwatts). If the link is lost at some point, a cross is shown.
c. **Coloured line.** A visual reference for link quality: green means good, yellow/orange means medium, red means low.

## Viewing the alignment info of a specific link

Tapping a node's name opens a screen with the details of that link. It is useful when you want to point the base node at a specific neighbour, get more information, and avoid being confused by the other links.

![Specific link details](/guide/limeapp/images/alignment_detail.png)

1. **Link-quality value** in dBm (decibel-milliwatts).
2. **Signal-read-out speaker.** A voice reads out the current signal. It is useful while aligning: you can hear the value without looking at the screen. Enable or disable it from the same icon 🔈/🔇.
3. **Coloured reference line** for link quality.
![Quality colour scale](/guide/limeapp/images/alignment_color_scale.png)
4. **The radio from which the base node is pointing.**
5. **The name of the node you are aligning against** and the radio it is on.
6. Best signal. Shows the best alignment achieved, with a seconds reference.

To return to the main alignment screen, use the back button in the upper-left corner:

![Back button](/guide/limeapp/images/alignment_back_button.png)

## When no possible link is found

If the base node does not see any signal on one of its radios, the screen reads «This radio is not linked to other nodes»:

![No link found](/guide/limeapp/images/alignment_no_link.png)

## When a link loses signal

The following information is displayed:

![Lost link](/guide/limeapp/images/alignment_lost.png)

📌 For more information and recommendations, see [Aligning antennas of a LibreRouter with LimeApp](/guide/limeapp/aligning-antennas).

---

> **Attribution.** Translated from [«Alineación»](https://conectividad.altermundi.net/documentacion/usar-limeapp1-4/un-paseo-por-el-menu-1-4/alineacion/) by [AlterMundi](https://altermundi.net/), licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
52 changes: 52 additions & 0 deletions docs/guide/limeapp/diagnostics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
outline: deep
---

# Diagnostics

The diagnostics screen provides information and runs several evaluations on the path that the network automatically chooses to connect the base node to the Internet.

There are two options:

![Diagnostics options](/guide/limeapp/images/diagnostics_options.png)

## 1. Only the gateway

This is the basic diagnostic process that runs automatically when you open the screen. You can repeat it as many times as you want by pressing the button.

It evaluates the bandwidth and the packet loss between the base node and the device that connects to the Internet (the gateway).

![Only the gateway](/guide/limeapp/images/diagnostics_gateway.png)

a. The **name of the base node** from which the evaluation is being run.
b. The path that the network chose the last time it connected the base node to the gateway.
c. The **bandwidth**, measured in megabits per second, and the **packet-loss** percentage, only between the base node and the gateway node (named «lapraviana» in this example).
d. Whether the base node has Internet connectivity through **IPv4**, **IPv6**, and the **DNS** service.

## 2. Measure the whole path

Starts an evaluation of the connectivity between the base node and every [intermediate node](https://hackmd.io/@0Rv5Hx8qSFeNy_M3SAM-Xw/SkjJ0Hwxu#Nodos-intermedios), including the gateway node and its Internet connection.

![Measure the whole path](/guide/limeapp/images/diagnostics_full_path.png)

a. The **name of the base node** from which the evaluation is being run.
b. The path that the network chose the last time it connected the base node to the gateway. For every [intermediate node](https://hackmd.io/@0Rv5Hx8qSFeNy_M3SAM-Xw/SkjJ0Hwxu#Nodos-intermedios), it shows the **bandwidth** measured between the base node and the intermediate node, plus the **packet loss** during the test.
c. Whether the base node has Internet connectivity through **IPv4**, **IPv6**, and the **DNS** service.

📌 **Tips**

- While a measurement is running, three animated dots are shown to indicate that you need to wait for the result.
![Measurement in progress](/guide/limeapp/images/diagnostics_in_progress.png)
- The coloured bars under the per-node measurements vary in length ↔ according to the bandwidth, and in colour according to the packet loss. They are a graphical reference that, with experience, lets you tell at a glance whether a result is optimal, acceptable, or in clear need of improvement.
![Diagnostics colour bars](/guide/limeapp/images/diagnostics_color_bars.png)
- If you need to evaluate or re-evaluate a single link along the path, tap the name of any intermediate node. LimeApp will then show the link-specific information between the base node and the node you tapped.

---

If the network breaks and there is no working path between the base node and the gateway, LimeApp evaluates the last path that **did** work. When you select the *measure the whole path* option, the result is striking: the base node evaluates itself against every node of that path that is still in the network. Nodes that are no longer reachable come back with a **(Error)** message.

![Broken path diagnostics](/guide/limeapp/images/diagnostics_broken_path.png)

---

> **Attribution.** Translated from [«Diagnóstico»](https://conectividad.altermundi.net/documentacion/usar-limeapp1-4/un-paseo-por-el-menu-1-4/diagnostico/) by [AlterMundi](https://altermundi.net/), licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
Loading