Skip to content

Commit 78766d3

Browse files
committed
lime-app: minor fixes
- adjust lime-app menu with nested menu - remove `outline: deep` which is on by default in docs/.vitepress/config.mts - rename directories 'limeapp` to `lime-app`
1 parent 770283a commit 78766d3

117 files changed

Lines changed: 14036 additions & 315 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/.vitepress/config.mts

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -99,23 +99,24 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
9999
items: [
100100
{ text: 'Connecting to the router', link: '/guide/connecting' },
101101
{ text: 'Using LimeApp',
102-
link: '/guide/limeapp/',
102+
link: '/guide/lime-app/',
103103
collapsed: true,
104104
items: [
105-
{ text: 'Overview', link: '/guide/limeapp/' },
106-
{ text: 'Accessing LimeApp', link: '/guide/limeapp/access' },
107-
{ text: 'A tour of the menu', link: '/guide/limeapp/menu' },
108-
{ text: 'Status', link: '/guide/limeapp/status' },
109-
{ text: 'Alignment', link: '/guide/limeapp/alignment' },
110-
{ text: 'Map', link: '/guide/limeapp/map' },
111-
{ text: 'Diagnostics', link: '/guide/limeapp/diagnostics' },
112-
{ text: 'Notes', link: '/guide/limeapp/notes' },
113-
{ text: 'Node configuration', link: '/guide/limeapp/node-config' },
114-
{ text: 'Network configuration', link: '/guide/limeapp/network-config' },
115-
{ text: 'Firmware', link: '/guide/limeapp/firmware' },
116-
{ text: 'Visit neighbor node', link: '/guide/limeapp/visit-node' },
117-
{ text: 'Remote support', link: '/guide/limeapp/remote-support' },
118-
{ text: 'Aligning antennas', link: '/guide/limeapp/aligning-antennas' },
105+
{ text: 'Overview', link: '/guide/lime-app/' },
106+
{ text: 'Accessing LimeApp', link: '/guide/lime-app/access' },
107+
{ text: 'Aligning antennas', link: '/guide/lime-app/aligning-antennas' },
108+
{ text: 'A tour of the menu', link: '/guide/lime-app/menu', items: [
109+
{ text: 'Status', link: '/guide/lime-app/status' },
110+
{ text: 'Alignment', link: '/guide/lime-app/alignment' },
111+
{ text: 'Map', link: '/guide/lime-app/map' },
112+
{ text: 'Diagnostics', link: '/guide/lime-app/diagnostics' },
113+
{ text: 'Notes', link: '/guide/lime-app/notes' },
114+
{ text: 'Node configuration', link: '/guide/lime-app/node-config' },
115+
{ text: 'Network configuration', link: '/guide/lime-app/network-config' },
116+
{ text: 'Firmware', link: '/guide/lime-app/firmware' },
117+
{ text: 'Visit neighbor node', link: '/guide/lime-app/visit-node' },
118+
{ text: 'Remote support', link: '/guide/lime-app/remote-support' },
119+
] },
119120
]
120121
},
121122
{ text: 'Packages selection',

docs/.vitepress/theme/style.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,3 +139,8 @@
139139
);
140140
}
141141

142+
.custom-block-info > img {
143+
display: inline;
144+
height: 1em;
145+
padding-right: .5em;
146+
}

docs/build/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
outline: deep
3-
---
4-
51
# Build LibreMesh
62

73
## Recommended methods

docs/features.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
outline: deep
3-
---
4-
51
# Features
62

73
## Modularity

docs/guide/connecting.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ These addresses are available as well:
1313
- http://\[fd0d:fe46:8ce8::1\] - default anygw ipv6
1414
- http://\[fd0d:fe46:8ce8::x\:xx\] - node default LAN `br-lan` ipv6 address
1515

16+
::: tip <span class="custom-block-info">![LibreRouter](/librerouter_icon.svg) LibreRouterOS</span>
1617
The recommended way to access the node on a LibreRouter is through the
1718
**LimeApp** web interface that comes preinstalled. It is a friendlier
1819
alternative to LuCI/SSH for everyday node administration and is the
1920
default UI of LibreRouterOS. See the full
20-
[Using LimeApp](/guide/limeapp/) guide for a tour of its features
21+
[Using LimeApp](/guide/lime-app/) guide for a tour of its features
2122
(status, alignment, diagnostics, firmware update, etc.).
23+
:::
2224

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

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
outline: deep
3-
---
4-
51
# Accessing LimeApp
62

73
The most common way to reach LimeApp is from the **Wi-Fi connection** of the phone or notebook you are using.
@@ -11,14 +7,14 @@ The most common way to reach LimeApp is from the **Wi-Fi connection** of the pho
117
3. Open a browser (Chrome, Firefox, etc.).
128
4. Type [`http://minodo.info`](http://minodo.info) in the address bar.
139

14-
![Accessing LimeApp from Wi-Fi](/guide/limeapp/images/access_wifi.png)
10+
![Accessing LimeApp from Wi-Fi](/guide/lime-app/images/access_wifi.png)
1511

1612
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.
1713

18-
![Accessing LimeApp from a wired connection](/guide/limeapp/images/access_cable.png)
14+
![Accessing LimeApp from a wired connection](/guide/lime-app/images/access_cable.png)
1915

2016
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.
2117

2218
---
2319

24-
> **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/).
20+
> **Attribution.** Translated from [«¿Cómo acceder?»](https://conectividad.altermundi.net/documentacion/usar-lime-app1-4/como-acceder/) by [AlterMundi](https://altermundi.net/), licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
Lines changed: 13 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
outline: deep
3-
---
4-
51
# Aligning the antennas of a LibreRouter with LimeApp
62

73
Achieving the best possible alignment on a Wi-Fi link is very important for the proper functioning of the community network and its performance.
@@ -15,7 +11,7 @@ It is a low-complexity task that requires dedication, patience, and time.
1511
- [🙌 Recommendations before you start](#🙌-recommendations-before-you-start)
1612
- [✅ Verify that the LibreRouters are linked](#✅-verify-that-the-librerouters-are-linked)
1713
- [🎯 Let's align!](#🎯-let-s-align)
18-
- [Using the Alignment tool of LimeApp](#using-the-alignment-tool-of-limeapp)
14+
- [Using the Alignment tool of LimeApp](#using-the-alignment-tool-of-lime-app)
1915
- [Going for it!](#going-for-it)
2016
- [📌 Things to keep in mind](#📌-things-to-keep-in-mind)
2117
- [Long links](#long-links)
@@ -33,9 +29,9 @@ To work properly, a few prerequisites and materials need to be checked:
3329
- **Loosen the antennas a little**, but tight enough that they do not move unless you hold them. This lets you move them during alignment.
3430
- **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.
3531
- **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.
36-
![Satellite map preview](/guide/limeapp/images/aligning_satellite_map.png)
32+
![Satellite map preview](/guide/lime-app/images/aligning_satellite_map.png)
3733
- **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).
38-
![Elevation profile](/guide/limeapp/images/aligning_elevation_profile.png)
34+
![Elevation profile](/guide/lime-app/images/aligning_elevation_profile.png)
3935

4036
## ✅ Verify that the LibreRouters are linked
4137

@@ -46,7 +42,7 @@ To work properly, a few prerequisites and materials need to be checked:
4642
- LimeApp reports the situation on a screen that reads «This radio is not linked to other nodes».
4743
- Check that you are pointing correctly:
4844
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.
49-
![No link warning](/guide/limeapp/images/aligning_no_link_warning.png)
45+
![No link warning](/guide/lime-app/images/aligning_no_link_warning.png)
5046
- Try a first *«by eye»* alignment until you obtain a link, even if the signal is poor.
5147
- 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.
5248
:::
@@ -55,19 +51,19 @@ To work properly, a few prerequisites and materials need to be checked:
5551

5652
### Using the Alignment tool of LimeApp
5753

58-
All the details about this tool are in the [Alignment](/guide/limeapp/alignment) page. Don't skip it! 🤓
54+
All the details about this tool are in the [Alignment](/guide/lime-app/alignment) page. Don't skip it! 🤓
5955

60-
1. Open [LimeApp](/guide/limeapp/access) of the base node you are working from.
61-
2. From the menu, go to the [Alignment](/guide/limeapp/alignment) screen.
56+
1. Open [LimeApp](/guide/lime-app/access) of the base node you are working from.
57+
2. From the menu, go to the [Alignment](/guide/lime-app/alignment) screen.
6258
3. Pick the node you are aligning against, and open the specific, detailed information.
6359

64-
![Alignment tool](/guide/limeapp/images/aligning_tool.png)
60+
![Alignment tool](/guide/lime-app/images/aligning_tool.png)
6561

6662
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.
6763

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

70-
![Signal value colour coding](/guide/limeapp/images/aligning_signal_value.png)
66+
![Signal value colour coding](/guide/lime-app/images/aligning_signal_value.png)
7167

7268
✔ Treat the best value you have repeated several times as valid.
7369
✘ Discard isolated values that represent a sudden jump in the measurement, however good they look, because they are not representative.
@@ -78,7 +74,7 @@ LimeApp uses the colours **green**, **yellow**, and **red** to identify whether
7874

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

81-
![Slow movement](/guide/limeapp/images/aligning_movement.png)
77+
![Slow movement](/guide/lime-app/images/aligning_movement.png)
8278

8379
1. **Move the desired antenna horizontally ↔** until you get the best value.
8480
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.
@@ -95,13 +91,13 @@ LimeApp uses the colours **green**, **yellow**, and **red** to identify whether
9591

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

98-
![Long links](/guide/limeapp/images/aligning_long_links.png)
94+
![Long links](/guide/lime-app/images/aligning_long_links.png)
9995

10096
### Covering an area
10197

10298
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.
10399

104-
![Covering an area](/guide/limeapp/images/aligning_cover_area.png)
100+
![Covering an area](/guide/lime-app/images/aligning_cover_area.png)
105101

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

@@ -111,4 +107,4 @@ For example, in the image above, the coverage angle aims to reach nodes 1, 2, an
111107

112108
---
113109

114-
> **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/).
110+
> **Attribution.** Translated from [«Alinear antenas de un Equipo LibreRouter con LimeApp 1.4»](https://conectividad.altermundi.net/documentacion/usar-lime-app1-4/alinear-antenas-de-un-equipo-librerouter-con-lime-app-1-4/) by [AlterMundi](https://altermundi.net/), licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
outline: deep
3-
---
4-
51
# Alignment
62

73
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.
@@ -12,18 +8,17 @@ The alignment screen is a tool for evaluating and improving the quality of the W
128
- [When a link loses signal](#when-a-link-loses-signal)
139

1410
## Main screen and associated nodes
15-
1611
When you open the screen, this is the main view:
1712

18-
![Alignment main screen](/guide/limeapp/images/alignment_radios.png)
13+
![Alignment main screen](/guide/lime-app/images/alignment_radios.png)
1914

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

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

26-
![Node list with link quality](/guide/limeapp/images/alignment_nodes.png)
21+
![Node list with link quality](/guide/lime-app/images/alignment_nodes.png)
2722

2823
a. **The name of the node and the radio through which the base node is communicating with it.**
2924
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.
@@ -33,34 +28,34 @@ When you open the screen, this is the main view:
3328

3429
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.
3530

36-
![Specific link details](/guide/limeapp/images/alignment_detail.png)
31+
![Specific link details](/guide/lime-app/images/alignment_detail.png)
3732

3833
1. **Link-quality value** in dBm (decibel-milliwatts).
3934
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 🔈/🔇.
4035
3. **Coloured reference line** for link quality.
41-
![Quality colour scale](/guide/limeapp/images/alignment_color_scale.png)
36+
![Quality colour scale](/guide/lime-app/images/alignment_color_scale.png)
4237
4. **The radio from which the base node is pointing.**
4338
5. **The name of the node you are aligning against** and the radio it is on.
4439
6. Best signal. Shows the best alignment achieved, with a seconds reference.
4540

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

48-
![Back button](/guide/limeapp/images/alignment_back_button.png)
43+
![Back button](/guide/lime-app/images/alignment_back_button.png)
4944

5045
## When no possible link is found
5146

5247
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»:
5348

54-
![No link found](/guide/limeapp/images/alignment_no_link.png)
49+
![No link found](/guide/lime-app/images/alignment_no_link.png)
5550

5651
## When a link loses signal
5752

5853
The following information is displayed:
5954

60-
![Lost link](/guide/limeapp/images/alignment_lost.png)
55+
![Lost link](/guide/lime-app/images/alignment_lost.png)
6156

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

6459
---
6560

66-
> **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/).
61+
> **Attribution.** Translated from [«Alineación»](https://conectividad.altermundi.net/documentacion/usar-lime-app1-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/).

0 commit comments

Comments
 (0)