Skip to content

Commit a5e91cf

Browse files
committed
fix(eppp_link): Update docs
1 parent 796fe19 commit a5e91cf

File tree

7 files changed

+195
-138
lines changed

7 files changed

+195
-138
lines changed

components/eppp_link/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,17 @@ The component provides a general purpose connectivity engine between two micro-c
1717

1818
* `eppp_connect()` -- Simplified API. Provides the initialization, starts the task and blocks until we're connected
1919

20-
* `eppp_client_init()` -- Initialization of the client. Need to run only once.
21-
* `eppp_client_start()` -- Starts the connection, could be called after startup or whenever a connection is lost
22-
* `eppp_client_perform()` -- Perform one iteration of the PPP task (need to be called regularly in task-less configuration)
23-
2420
### Server
2521

2622
* `eppp_listen()` -- Simplified API. Provides the initialization, starts the task and blocks until the client connects
27-
* `eppp_server_init()` -- Initialization of the server. Need to run only once.
28-
* `eppp_server_start()` -- (Re)starts the connection, should be called after startup or whenever a connection is lost
29-
* `eppp_server_perform()` -- Perform one iteration of the PPP task (need to be called regularly in task-less configuration)
23+
24+
### Manual actions
25+
26+
* `eppp_init()` -- Initializes one endpoint (client/server).
27+
* `eppp_deinit()` -- Destroys the endpoint
28+
* `eppp_netif_start()` -- Starts the network, could be called after startup or whenever a connection is lost
29+
* `eppp_netif_stop()` -- Stops the network
30+
* `eppp_perform()` -- Perform one iteration of the PPP task (need to be called regularly in task-less configuration)
3031

3132
## Throughput
3233

@@ -37,7 +38,7 @@ Tested with WiFi-NAPT example, no IRAM optimizations
3738
* TCP - 2Mbits
3839
* UDP - 2Mbits
3940

40-
### SPI @ 40MHz
41+
### SPI @ 20MHz
4142

4243
* TCP - 6Mbits
4344
* UDP - 10Mbits

0 commit comments

Comments
 (0)