Repository : ssh://git@open-mesh.org/doc
On branches: backup-redmine/2017-07-13,master
commit 4fdd9e46456cd079d1971cc1ef11343ce68585a9 Author: Marek Lindner mareklindner@neomailbox.ch Date: Wed Sep 9 14:58:38 2009 +0000
doc: batmand/VisualizeMesh: beautifications ...
4fdd9e46456cd079d1971cc1ef11343ce68585a9 batmand/VisualizeMesh.textile | 78 +++++++++++++++---------------------------- 1 file changed, 27 insertions(+), 51 deletions(-)
diff --git a/batmand/VisualizeMesh.textile b/batmand/VisualizeMesh.textile index c5f3a9a9..e993fb0d 100644 --- a/batmand/VisualizeMesh.textile +++ b/batmand/VisualizeMesh.textile @@ -1,80 +1,56 @@ +== Visualize the mesh ==
-h2. Visualize the mesh - - -*Concept* - -In contrast to other routing protocols each batman node only knows the path to its single hop neighbors and - -knows nothing about the topology behind it. In practice it means that a batman node S is aware of node A - -which is somewhere in the mesh and reachable via neighbor B but it does not know about the number of hops - -and / or nodes in between. This approach is quite handy with regard to memory footprint, mesh stability and - -bandwidth friendliness but somewhat hard to visualize. Therefore a small helper was created: the vis server. - -It gathers the local views of each node and assembles a graph that can be fed into various tools which output +'''Concept'''
+In contrast to other routing protocols each batman node only knows the path to its single hop neighbors and[[BR]] +knows nothing about the topology behind it. In practice it means that a batman node S is aware of node A[[BR]] +which is somewhere in the mesh and reachable via neighbor B but it does not know about the number of hops[[BR]] +and / or nodes in between. This approach is quite handy with regard to memory footprint, mesh stability and[[BR]] +bandwidth friendliness but somewhat hard to visualize. Therefore a small helper was created: the vis server.[[BR]] +It gathers the local views of each node and assembles a graph that can be fed into various tools which output[[BR]] an eye-candy graphic of the networks topology.
-*Batman nodes* - -Each batman node needs to know the IP address of the vis server it should send the vis packets to. This - -packet is sent every few seconds containing various information about the local neighbors (including their +'''Batman nodes'''
+Each batman node needs to know the IP address of the vis server it should send the vis packets to. This[[BR]] +packet is sent every few seconds containing various information about the local neighbors (including their[[BR]] link qualities), secondary interfaces and announced networks.
Example: batmand -s visIP [interface]
-The vis server can run in the mesh itself or somewhere in the internet, just make sure that batman can reach - +The vis server can run in the mesh itself or somewhere in the internet, just make sure that batman can reach[[BR]] the given vis IP.
-*Vis server* - -The vis server can run on multiple interfaces and expects incoming vis packets on UDP port 4307. Per default - -it sends the assembled graph to all clients connected to TCP port 2004 every few seconds. It uses the +'''Vis server'''
+The vis server can run on multiple interfaces and expects incoming vis packets on UDP port 4307. Per default[[BR]] +it sends the assembled graph to all clients connected to TCP port 2004 every few seconds. It uses the [[BR]] standardized dot draw format to express the relationships among the nodes.
Example: vis [interface] [interface]
-The vis server 0.3.2 (and later) additionally offer JSON as output format. Once activated you can retrieve the - -JSON output on TCP port 2005 (dot draw remains available on port 2004). - +The vis server 0.3.2 (and later) additionally offer JSON as output format. Once activated you can retrieve the[[BR]] +JSON output on TCP port 2005 (dot draw remains available on port 2004).[[BR]]
Example: vis -j [interface] [interface]
-Make sure that all mentioned ports are not blocked by a firewall. You can verify whether your setup works by - -using e.g. telnet to connect to port 2004 or 2005. - - - -*Fancy graphics* - -If you intend to create images like the one below you need to use one of the many tools available. That - -screenshot was made by connecting mesh3d (which is part of the "s3d tools":http://s3d.berlios.de/ - debian packages are available) - -to the vis servers dot draw output (on port 2004). - - - -If you have impressive screenshots don't hesitate to let us know. :-) - - +Make sure that all mentioned ports are not blocked by a firewall. You can verify whether your setup works by[[BR]] +using e.g. telnet to connect to port 2004 or 2005. [[BR]]
+'''Fancy graphics'''
+If you intend to create images like the one below you need to use one of the many tools available. That [[BR]] +screenshot was made by connecting mesh3d (which is part of the [http://s3d.berlios.de/ s3d tools] - debian packages are available) [[BR]] +to the vis servers dot draw output (on port 2004).[[BR]] +[[BR]] +If you have impressive screenshots don't hesitate to let us know. :-)[[BR]] +[[BR]] +[[BR]]
[[Image(08-vis_zoomed.png)]]