use libremesh.data.js + minor fixes

Author: a-gave

docs/.vitepress/config.mts

@@ -5,13 +5,6 @@ import { generateSidebarItems, getFiles } from './sidebar'
 const isFork = process.env.IS_FORK === '1'
 const baseUrl = isFork && '/libremesh.github.io' || ''
 
-const libremesh = {
-  stable_version: '2024.1',
-  stable_branch_openwrt: ['23.05'],
-  oldstable_version: '2020.4',
-  oldstable_branch_openwrt: ['19.07'],
-}
-
 const packages = await getFiles('docs/packages/*/index.md');
 const profiles = await getFiles('docs/profiles/packages/*/index.md');
 const communities = await getFiles('docs/profiles/communities/*/index.md');
@@ -81,7 +74,7 @@ function nav(): DefaultTheme.NavItem[] {
       items: [
         { text: 'v2024.1', link: '/news/2023-10-07' },
         { text: 'v2020.4', link: '/news/2025-05-04' },
-        { text: 'Latest Articles', link: '/news' },
+        { text: 'Latest Articles', link: '/news/' },
         { text: 'Changelog', link: 'changelog'},
         { text: 'Issues', link: 'https://github.com/libremesh/lime-packages/issues'},
       ]
@@ -196,8 +189,8 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
         { text: 'Default protocols', 
           collapsed: true,
           items: [
-          { text: 'Batman-adv', link: 'protocols/batman-adv'},
-          { text: 'Babeld', link: 'protocols/babeld'},
+          { text: 'Batman-adv', link: 'network/protocols/batman-adv'},
+          { text: 'Babeld', link: 'network/protocols/babeld'},
         ]},
         { text: 'lime-files', items: [
           { text: 'System', link: 'system' },

docs/build/buildroot.md

@@ -15,7 +15,7 @@ Refers to the OpenWrt wiki [Build system setup](https://openwrt.org/docs/guide-d
 for the package list of other Linux distributions.
 
 ### Debian/Ubuntu/Mint
-```
+```sh
 sudo apt update
 sudo apt install build-essential clang flex bison g++ gawk \
 gcc-multilib g++-multilib gettext git libncurses5-dev libssl-dev \

docs/build/lime-sdk.md

@@ -2,6 +2,9 @@
 aside: false
 ---
 # lime-sdk cooker
+
+[[toc]]
+
 LibreMesh **software development kit** uses the [OpenWRT](https://openwrt.org) SDK and ImageBuilder to generate (**cook**) LibreMesh packages and firmware. If you want to create your own LibreMesh flavor because you need some specific configuration or you just want to have control over your binaries, the cooker is your friend!
 
 Basic usage example for cooking a libremesh using bmx7 routing protocol firmware for device Alix Board 2d2 using remote repositories (no compilation required). Recommended for most people:

docs/getting-started.md

@@ -1,7 +1,3 @@
----
-outline: deep
----
-
 # Getting Started
 
 ## Installation
@@ -19,25 +15,33 @@ Read the OpenWrt's [`8/64 warning`](https://openwrt.org/supported_devices/864_wa
 :::
 
 ::: warning CAUTION
-Ensure to have read the OpenWrt's wiki page for of your device.    
-Read the installation instruction and ensure to have the necessary hardware equipment - if needed on your device - to install the firmware, like an [USB-UART/Serial adapter](https://openwrt.org/docs/guide-user/installation/generic.flashing.serial) and/or an
+Ensure to have read the OpenWrt's wiki page of your device.    
+Read the installation instruction and ensure to have the necessary hardware equipment - if needed - to install the firmware, like an [USB-UART/Serial adapter](https://openwrt.org/docs/guide-user/installation/generic.flashing.serial) and/or an
 [USB-JTAG adapter](https://openwrt.org/docs/techref/hardware/port.jtag)
 :::
 
 ### Download the firmware
-**Download using the Firmware Selector**    
+---
+
+**Firmware Selector**   
 The Firmware Selector request a firmware build via an [`ASU`](https://github.com/openwrt/asu) (online ImageBuilder) instance.
 
 https://firmware-selector.libremesh.org
 
-**Download old precompiled versions**    
-Old releases archive with pre-compiled firmwares via Buildroot are available at:
+---
+
+**Precompiled versions**    
+Old releases archive with pre-compiled firmwares via Buildroot.
 
 https://firmware-libremesh.antennine.org
 
+---
+
 **Build LibreMesh on your host**    
 Refers the the page [`Build LibreMesh`](/build/) for instructions on how to build LibreMesh on your host.
 
+---
+
 ### Install the firmware
 Install the firmware on your device following the installation method reported in the [wiki of OpenWrt](https://openwrt.org)
 or, if not present, search the instruction in the **`git-commit` message** left from who added the support for that device model. See the [Table of Hardware](https://toh.openwrt.org).
@@ -47,13 +51,13 @@ If your device runs OEM firmware it is adviced to **install OpenWrt first**:
 :::
 
 1. Download the latest `stable` firmware for your device from the [`OpenWrt Firmware Selector`](https://firmware-selector.openwrt.org).    
-   Use the `factory` image for first time installation. See the OpenWrt wiki page [Factory Install: First Time Installation](https://openwrt.org/docs/guide-quick-start/factory_installation):
+   Use the `factory` image for first time installation. See OpenWrt [Factory Install: First Time Installation](https://openwrt.org/docs/guide-quick-start/factory_installation):
 2. Check that the OpenWrt device boot and function properly.    
    Beware that OpenWrt by default doesn't turn on the Wi-Fi.    
    Turn it on from `LuCi` from the menu `Network` / `Wireless`.
-3. Upgrade to LibreMesh using a `sysupgrade` image:
-    - upload the firmware via the web interface `LuCI` from the menu `System` / `Backup / Flash Firmware`.
-    - or via ssh using the command `sysupgrade -n firmware.bin`
+3. Upgrade to LibreMesh using a `squashfs-sysupgrade.bin` image:
+    - Upload the firmware via the web interface `LuCI` from the menu `System` / `Backup / Flash Firmware`.
+    - Or install via ssh using the command `sysupgrade -n firmware.bin`.
 
 
 ## Connecting to the router

docs/guide/packages-selection.md

@@ -3,6 +3,7 @@ outline: deep
 ---
 <script setup>
 import { data as openwrt } from '/openwrt.data.js'
+import { data as libremesh } from '/libremesh.data.js'
 </script>
 
 # Packages selection
@@ -37,17 +38,9 @@ For `8/64` devices it should be possible to install a reduced version of the `de
 See details of excluded packages at [Flavor Mini](/reference/flavors.md#flavor-mini)
 This package list is selectable also by including the network-profile `profile-libremesh-suggested-packages-tiny`.
 
-```
-babeld-auto-gw-mode
-check-date-http
-lime-docs-minimal
-lime-hwd-openwrt-wan
-lime-proto-anygw
-lime-proto-babeld
-lime-proto-batadv
-shared-state
-shared-state-babeld_hosts
-```
+<ul>
+<li v-for="p in libremesh.flavors.mini"><a :href="'/packages/'+p">{{ p }}</a></li>
+</ul>
 
 ### Excluding packages
 

docs/libremesh.data.js

@@ -0,0 +1,44 @@
+
+export default {
+  async load() {
+    // fetch remote data
+    return {
+      stable_version: '2024.1',
+      stable_branch_openwrt: ['23.05'],
+      oldstable_version: '2020.4',
+      oldstable_branch_openwrt: ['19.07'],
+      flavors: {
+        default: [
+          "babeld-auto-gw-mode",
+          "batctl-default",
+          "check-date-http",
+          "lime-app",
+          "lime-debug",
+          "lime-docs-minimal",
+          "lime-hwd-ground-routing",
+          "lime-hwd-openwrt-wan",
+          "lime-proto-anygw",
+          "lime-proto-babeld",
+          "lime-proto-batadv",
+          "shared-state",
+          "shared-state-async",
+          "shared-state-babeld_hosts",
+          "shared-state-bat_hosts",
+          "shared-state-nodes_and_links"
+        ],
+        mini: [
+          "babeld-auto-gw-mode",
+          "check-date-http",
+          "lime-docs-minimal",
+          "lime-hwd-openwrt-wan",
+          "lime-proto-anygw",
+          "lime-proto-babeld",
+          "lime-proto-batadv",
+          "shared-state",
+          "shared-state-babeld_hosts",
+          "shared-state-nodes_and_links"
+        ]
+      }
+    }
+  }
+}

docs/reference/configuration.md

@@ -21,11 +21,29 @@ The options contained in these files are merged and overwritten from the lowest
 ├─ lime-node - node configuration
 └─ lime-autogen - DO NOT EDIT, autogenerated configuration
 ```
-
-::: tip Interface specific options
-Interface specific options have to be included in `lime-node` or `lime-<MAC>`.
+### Sections
+The configuration is divided into three main sections: 
+- `config lime system`
+- `config lime network`
+- `config lime wifi`
+
+By default followed by radio band specific configurations
+- `config lime-wifi-band 2ghz`
+- `config lime-wifi-band 5ghz`
+
+Optionally followed by interface specific sections, and protocols specific options
+- `config net port1`
+- `config wifi radio0` configur
+
+::: tip Interface specific section
+Interface specific section have to be included in `lime-node` or `lime-<MAC>`.
 :::
 
+Optionally followed by other protocols specific, scripts and uci configs, or hardware_modules
+- `config bgp_peer peer1` 
+- `config generic_uci_config uhttpd_https`
+- `config hwd_watchcat periodic_reboot`
+
 ### Parametrizable options
 Inside `lime-files` the options marked with `Parametrizable with %Mn, %Nn, %H`, can include the templates:
 - `%Mn`: replaced by the n'th byte of the **`primary_interface` MAC**

docs/reference/flavors.md

@@ -1,29 +1,19 @@
----
-outline: deep
----
+<script setup>
+import { data as libremesh } from '/libremesh.data.js'
+</script>
 
 # Flavors
 
 ## Default flavor
 
 ### Packages list 
 The LibreMesh default `flavor` contains these packages:
-- babeld-auto-gw-mode
-- batctl-default
-- check-date-http
-- lime-app
-- lime-debug
-- lime-docs
-- lime-docs-minimal
-- lime-hwd-ground-routing
-- lime-hwd-openwrt-wan
-- lime-proto-anygw
-- lime-proto-babeld
-- lime-proto-batadv
-- shared-state
-- shared-state-babeld_hosts
-- shared-state-bat_hosts
-- shared-state-nodes_and_links
+<ul>
+<li v-for="p in libremesh.flavors.default">
+  <a v-if="!['batctl-default'].includes(p)" :href="'/packages/'+p">{{ p }}</a>
+  <span v-else>{{ p }}</span>
+</li>
+</ul>
 
 ### Configuration
 
@@ -85,15 +75,9 @@ The information shared by default depends from shared-state's `publishers` insta
 ### Packages list
 The LibreMesh `mini` flavor contains these packages:
 
-- babeld-auto-gw-mode
-- check-date-http
-- lime-docs-minimal
-- lime-hwd-openwrt-wan
-- lime-proto-anygw
-- lime-proto-babeld
-- lime-proto-batadv
-- shared-state
-- shared-state-babeld_hosts
+<ul>
+<li v-for="p in libremesh.flavors.mini"><a :href="'/packages/'+p">{{ p }}</a></li>
+</ul>
 
 ### Configuration
 The configuration is the same as the one of the default flavor.

docs/reference/network/protocols-list.md

@@ -47,9 +47,12 @@ uci get lime-autogen.network.protocols
 
 ```
     list protocols batadv:%N1
-#   list protocols batadv:0
 ```
 If the vlan is `0` tags are disabled and the routing is done on the raw interface.
+```
+    list protocols batadv:0
+```
+
 ::: tip 
 See the page about [batman-adv](protocols/batman-adv) for the default configuration.
 :::

docs/reference/network/protocols/babeld.md

@@ -58,4 +58,34 @@ config filter 'denyany'
 	option type 'redistribute'
 	option action 'deny'
 
+```
+
+## Examples
+
+---
+
+### ubus
+
+**list commands**
+```
+ubus -v list babeld
+'babeld' @98e57cc3
+	"add_interface":{"ifname":"String"}
+	"add_filter":{"ifname":"String","type":"Integer","metric":"Integer"}
+	"get_info":{}
+	"get_xroutes":{}
+	"get_routes":{}
+	"get_neighbours":{}
+```
+---
+
+**get_info**
+```
+ubus call babeld get_info
+{
+	"babeld_version": "babeld-1.13.1-ubus-mod",
+	"my_id": "22:05:b7:ff:fe:00:04:80",
+	"host": "openwrt"
+}
+
 ```