alex
/
gluon-firmware
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update for reflect dropped IBSS support

This commit is contained in:
Matthias Schiffer 2019-11-05 20:50:37 +01:00
parent 335fae1025
commit ed8cd9c0f7
6 changed files with 37 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/dev/mac_addresses.rst
View File

@ -10,9 +10,9 @@ Gluon tries to solve this issue by using a hash of the primary MAC address as a
* 0: client0; WAN
* 1: mesh0
* 2: ibss0
* 2: (unused)
* 3: wan_radio0 (private WLAN); batman-adv primary address
* 4: client1; LAN
* 5: mesh1
* 6: ibss1
* 6: (unused)
* 7: wan_radio1 (private WLAN); mesh VPN

2
docs/features/multidomain.rst
View File

@ -198,8 +198,6 @@ domain.conf only variables
- must be a random value used to derive the vxlan id for wired meshing
- wifi*.ibss.ssid
- wifi*.ibss.bssid
- wifi*.mesh.id
- mesh_vpn.fastd.groups.*.peers.remotes
- mesh_vpn.fastd.groups.*.peers.key

16
docs/features/wlan-configuration.rst
View File

@ -2,10 +2,9 @@ WLAN configuration
==================
Gluon allows to configure 2.4GHz and 5GHz radios independently. The configuration
may include any or all of the three networks "client" (AP mode), "mesh" (802.11s
mode) and "ibss" (adhoc mode), which can be used simultaneously (using "mesh" and
"ibss" at same time should be avoided though as weaker hardware usually can't handle the additional
load). See :doc:`../user/site` for details on the configuration.
may include one or both of the two networks "client" (AP mode) and "mesh" (802.11s
mode), which can be used simultaneously. See :doc:`../user/site` for details on the
configuration.
Upgrade behaviour
-----------------
@ -16,15 +15,6 @@ on upgrades the existing setting is always retained (as this setting may have be
by the user). This means that it is not possible to enable or disable an existing network
configurations during upgrades.
For the "mesh" and "ibss" networks, the default setting only has an effect if none
of the two has existed before. If a new configuration has been added for "mesh" or "ibss",
while the other of the two has already existed before, the enabled/disabled state of the
existing configuration will also be set for the new configuration.
This allows upgrades to change from IBSS to 11s and vice-versa while retaining the
"wireless meshing is enabled/disabled" property configured by the user regardless
of the used mode.
During upgrades the wifi channel of the 2.4GHz and 5GHz radio will be restored to the channel
configured in the site.conf. If you need to preserve a user defined wifi channel during upgrades
you can configure this via the uci section ``gluon-core.wireless``::

2
docs/package/gluon-scheduled-domain-switch.rst
View File

@ -3,7 +3,7 @@ gluon-scheduled-domain-switch
This package allows to switch a routers domain at a given point
in time. This is needed for switching between incompatible transport
protocols (e.g. 802.11s and IBSS or VXLAN).
protocols (e.g. wired meshing with and without VXLAN).
Nodes will switch when the defined *switch-time* has passed. In case the node was
powered off while this was supposed to happen, it might not be able to acquire the

18
docs/user/site.rst
View File

@ -120,12 +120,11 @@ wifi24 \: optional
WLAN configuration for 2.4 GHz devices.
``channel`` must be set to a valid wireless channel for your radio.
There are currently three interface types available. You may choose to
There are currently two interface types available. You may choose to
configure any subset of them:
- ``ap`` creates a master interface where clients may connect
- ``mesh`` creates an 802.11s mesh interface with forwarding disabled
- ``ibss`` creates an ad-hoc interface
Each interface may be disabled by setting ``disabled`` to ``true``.
This will only affect new installations.
@ -139,10 +138,7 @@ wifi24 \: optional
don't want users to connect to this mesh-SSID, so use a cryptic id that no
one will accidentally mistake for the client WiFi.
``ibss`` requires two parameters: ``ssid`` (a string) and ``bssid`` (a MAC).
An optional parameter ``vlan`` (integer) is supported.
Both ``mesh`` and ``ibss`` accept an optional ``mcast_rate`` (kbit/s) parameter for
``mesh`` also accepts an optional ``mcast_rate`` (kbit/s) parameter for
setting the multicast bitrate. Increasing the default value of 1000 to something
like 12000 is recommended.
::
@ -156,11 +152,6 @@ wifi24 \: optional
id = 'ueH3uXjdp',
mcast_rate = 12000,
},
ibss = {
ssid = 'ff:ff:ff:ee:ba:be',
bssid = 'ff:ff:ff:ee:ba:be',
mcast_rate = 12000,
},
},
.. _user-site-wifi5:
@ -559,11 +550,6 @@ GLUON_LANGS
List of languages (as two-letter-codes) to be included in the web interface. Should always contain
``en``.
GLUON_WLAN_MESH
Setting this to ``11s`` or ``ibss`` will enable generation of matching images for devices which don't
support both meshing modes, either at all (e.g. ralink and mediatek don't support AP+IBSS) or in the
same firmware (ath10k-based 5GHz). Defaults to ``11s``.
.. _user-site-feature-flags:
Feature flags

67
docs/user/supported_devices.rst
View File

@ -41,7 +41,7 @@ ar71xx-generic
- GL-AR150
- GL-AR300M
- GL-AR750 [#ath10k]_
- GL-AR750
- GL-iNet 6408A (v1)
- GL-iNet 6416A (v1)
@ -57,7 +57,7 @@ ar71xx-generic
* OCEDO
- Koala [#ath10k]_
- Koala
* OpenMesh
@ -65,24 +65,24 @@ ar71xx-generic
- A60
- MR600 (v1, v2)
- MR900 (v1, v2)
- MR1750 (v1, v2) [#ath10k]_
- MR1750 (v1, v2)
- OM2P (v1, v2, v4)
- OM2P-HS (v1, v2, v3, v4)
- OM2P-LC
- OM5P
- OM5P-AN
- OM5P-AC (v1, v2) [#ath10k]_
- OM5P-AC (v1, v2)
* TP-Link
- Archer C5 (v1) [#ath10k]_
- Archer C59 (v1) [#80211s]_
- Archer C7 (v2, v4, v5) [#ath10k]_
- Archer C5 (v1)
- Archer C59 (v1)
- Archer C7 (v2, v4, v5)
- CPE210 (v1.0, v1.1, v2.0, v3.0)
- CPE220 (v1.1)
- CPE510 (v1.0, v1.1)
- CPE520 (v1.1)
- RE450 [#ath10k]_
- RE450
- TL-WDR3500 (v1)
- TL-WDR3600 (v1)
- TL-WDR4300 (v1)
@ -109,12 +109,12 @@ ar71xx-generic
- Rocket M2/M5
- Rocket M2/M5 Ti
- Rocket M2/M5 XW
- UniFi AC Mesh [#ath10k]_
- UniFi AC Mesh Pro [#ath10k]_
- UniFi AC Mesh
- UniFi AC Mesh Pro
- UniFi AP
- UniFi AP AC Lite [#ath10k]_
- UniFi AP AC LR [#ath10k]_
- UniFi AP AC Pro [#ath10k]_
- UniFi AP AC Lite
- UniFi AP AC LR
- UniFi AP AC Pro
- UniFi AP LR
- UniFi AP Pro
- UniFi AP Outdoor
@ -127,7 +127,7 @@ ar71xx-generic
* ZyXEL
- NBG6616 [#ath10k]_
- NBG6616
ar71xx-nand
-----------
@ -143,7 +143,7 @@ ar71xx-nand
* ZyXEL
- NBG6716 [#ath10k]_
- NBG6716
ar71xx-tiny [#deprecated]_
--------------------------
@ -191,8 +191,8 @@ brcm2708-bcm2709
* RaspberryPi 2
ipq40xx-generic [#80211s]_
--------------------------
ipq40xx-generic
---------------
* AVM
@ -217,8 +217,8 @@ ipq40xx-generic [#80211s]_
- NBG6617
- WRE6606
ipq806x-generic [#80211s]_
--------------------------
ipq806x-generic
---------------
* NETGEAR
@ -249,8 +249,8 @@ mpc85xx-p1020
- Panda
ramips-mt7620 [#80211s]_
------------------------
ramips-mt7620
-------------
* GL Innovations
@ -267,11 +267,11 @@ ramips-mt7621
* ASUS
- RT-AC57U [#80211s]_
- RT-AC57U
* D-Link
- DIR-860L (B1) [#80211s]_
- DIR-860L (B1)
* Ubiquiti
@ -280,11 +280,11 @@ ramips-mt7621
* ZBT
- WG3526-16M [#80211s]_
- WG3526-32M [#80211s]_
- WG3526-16M
- WG3526-32M
ramips-mt76x8 [#80211s]_
------------------------
ramips-mt76x8
-------------
* GL.iNet
@ -306,8 +306,8 @@ ramips-mt76x8 [#80211s]_
- VoCore2
ramips-rt305x [#80211s]_ [#deprecated]_
---------------------------------------
ramips-rt305x [#deprecated]_
----------------------------
* A5-V11
@ -358,14 +358,5 @@ Footnotes
The device or target is reaching its end of life soon. This means that support
in the next major release of Gluon is doubtful.
.. [#ath10k]
Device uses the ath10k WLAN driver. Images are built for 11s by default unless GLUON_WLAN_MESH
is set as described in :ref:`getting-started-make-variables`.
.. [#80211s]
Device or target does not support IBSS. Images are built by default unless
GLUON_WLAN_MESH is explicitly set to something other than *11s*. Targets that
are affected as a whole may not be selected for build in this case.
.. [#avmflash]
For instructions on how to flash AVM devices, visit https://fritzfla.sh