docs: document new mesh.batman_adv.routing_algo settings for coexistence

This commit is contained in:
Matthias Schiffer 2019-08-22 23:04:39 +02:00
parent cb899874dc
commit 79933d7e83
No known key found for this signature in database
GPG Key ID: 16EF3F64CB201D9C
3 changed files with 20 additions and 4 deletions

View File

@ -21,7 +21,7 @@
ip6 = 'fdxx:xxxx:xxxx:xxxx::xxxx', ip6 = 'fdxx:xxxx:xxxx:xxxx::xxxx',
}, },
wifi24= { wifi24 = {
ap = { ap = {
ssid = "alpha-centauri.example.org", ssid = "alpha-centauri.example.org",
channel = 1, channel = 1,
@ -31,7 +31,7 @@
}, },
}, },
wifi5= { wifi5 = {
ap = { ap = {
ssid = "alpha-centauri.example.org", ssid = "alpha-centauri.example.org",
channel = 44, channel = 44,
@ -41,6 +41,12 @@
}, },
}, },
mesh = {
batman_adv = {
routing_algo = 'BATMAN_IV',
},
},
mesh_vpn = { mesh_vpn = {
fastd = { fastd = {
groups = { groups = {

View File

@ -74,6 +74,9 @@
mesh = { mesh = {
vxlan = true, vxlan = true,
batman_adv = {
routing_algo = 'BATMAN_IV',
},
}, },
-- The next node feature allows clients to always reach the node it is -- The next node feature allows clients to always reach the node it is

View File

@ -238,8 +238,15 @@ mesh
In addition, options specific to the batman-adv routing protocol can be set In addition, options specific to the batman-adv routing protocol can be set
in the *batman_adv* section: in the *batman_adv* section:
The optional value *routing_algo* allows to set up ``BATMAN_V`` based meshes. The mandatory value *routing_algo* selects the batman-adv protocol variant.
If unset, the routing algorithm will default to ``BATMAN_IV``. The following values are supported:
- ``BATMAN_IV_LEGACY`` (*mesh-batman-adv-14*)
- ``BATMAN_IV`` (*mesh-batman-adv-15*)
- ``BATMAN_V`` (*mesh-batman-adv-15*)
When both *mesh-batman-adv-14* and *mesh-batman-adv-15* are included, this
setting specifies which one to use.
The optional value *gw_sel_class* sets the gateway selection class, the The optional value *gw_sel_class* sets the gateway selection class, the
default is ``20`` for B.A.T.M.A.N. IV and ``5000`` kbit/s for B.A.T.M.A.N. V. default is ``20`` for B.A.T.M.A.N. IV and ``5000`` kbit/s for B.A.T.M.A.N. V.