Skip to content

Commit 0516b30

Browse files
committed
- Fix Readme links.
1 parent f059e57 commit 0516b30

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

libraries/ESP8266WiFiMesh/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# ESP8266 WiFi Mesh
22

33
## Contents
4-
1. [Overview]
5-
* [How does it work?]
6-
2. [Tell me more]
4+
1. [Overview](#Overview)
5+
* [How does it work?](#Work)
6+
2. [Tell me more!](#More)
77
* [EspnowMeshBackend](#EspnowMeshBackendMore)
88
* [TcpIpMeshBackend](#TcpIpMeshBackendMore)
99
* [FloodingMesh](#FloodingMeshMore)
1010

1111

12-
## Overview
12+
## <a name="Overview"></a>Overview
1313

1414
This is a library for creating a mesh network using the ESP8266.
1515

1616
The library has been tested and works with Arduino core for ESP8266 version 2.7.2 (with lwIP2). It may work with earlier and later core releases, but this has not been tested during development.
1717

1818
**Note:** This mesh library has been extensively rewritten for core release 2.7.2. The old method signatures have been retained for compatibility purposes, but will be removed in core release 3.0.0. If you are still using these old method signatures please consider migrating to the new API shown in the `EspnowMeshBackend.h` or `TcpIpMeshBackend.h` source files.
1919

20-
### How does it work?
20+
### <a name="Work"></a>How does it work?
2121

22-
The ESP8266 WiFi Mesh library is a cake. Metaphorically speaking. At the bottom you have the general ESP8266 Arduino core WiFi functionality. On top of this two mesh backends have been created (`EspnowMeshBackend` and `TcpIpMeshBackend`), a yummy filling that completely covers the bottom. Then at the very top over the backends is the beautiful and delicious frosting: `FloodingMesh`. `FloodingMesh` is an actual mesh network implementation that uses the `EspnowMeshBackend`.
22+
The ESP8266 WiFi Mesh library is a cake, metaphorically speaking. At the bottom you have the general ESP8266 Arduino core WiFi functionality. On top of this two mesh backends have been created (`EspnowMeshBackend` and `TcpIpMeshBackend`), a yummy filling that completely covers the bottom. Then at the very top over the backends is the beautiful and delicious frosting: `FloodingMesh`. `FloodingMesh` is an actual mesh network implementation that uses the `EspnowMeshBackend`.
2323

2424
Eating the cake would typically be a process which involves all the layers, but it is completely possible to use both the EspnowMeshBackend and the TcpIpMeshBackend separately from FloodingMesh, perhaps to construct your own mesh network architecture or just to simplify the usage of TCP/IP or ESP-NOW. If you have made a nice mesh architecture with this library that you would like to share with the rest of the world, feel free to make a PR with it!
2525

@@ -31,7 +31,7 @@ Finally, three things are important to note:
3131
2. Both the `EspnowMeshBackend` and the `TcpIpMeshBackend` can be used simultaneously on the same node. However, since there is only one WiFi radio on the ESP8266, only one backend at a time will be responsible for the settings of this radio (SSID, WiFi channel etc.). The backend in control is known as the `APController` in the library. Both backends can still send messages, regardless of who is `APController`.
3232
3. The `MeshBackendBase`, `EspnowMeshBackend`, `TcpIpMeshBackend` and `FloodingMesh` source files are supposed to be the main front-ends of the library and are all extensively documented. If you wonder how something is working, chances are good that you will find an answer in the documentation of those files.
3333

34-
## Tell me more
34+
## <a name="More"></a>Tell me more!
3535

3636
### <a name="EspnowMeshBackendMore"></a>EspnowMeshBackend
3737

0 commit comments

Comments
 (0)