Skip to content

Commit

Permalink
fix(eppp_link): Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
david-cermak committed Jan 5, 2024
1 parent 796fe19 commit a5e91cf
Show file tree
Hide file tree
Showing 7 changed files with 195 additions and 138 deletions.
17 changes: 9 additions & 8 deletions components/eppp_link/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,17 @@ The component provides a general purpose connectivity engine between two micro-c

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

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

### Server

* `eppp_listen()` -- Simplified API. Provides the initialization, starts the task and blocks until the client connects
* `eppp_server_init()` -- Initialization of the server. Need to run only once.
* `eppp_server_start()` -- (Re)starts the connection, should be called after startup or whenever a connection is lost
* `eppp_server_perform()` -- Perform one iteration of the PPP task (need to be called regularly in task-less configuration)

### Manual actions

* `eppp_init()` -- Initializes one endpoint (client/server).
* `eppp_deinit()` -- Destroys the endpoint
* `eppp_netif_start()` -- Starts the network, could be called after startup or whenever a connection is lost
* `eppp_netif_stop()` -- Stops the network
* `eppp_perform()` -- Perform one iteration of the PPP task (need to be called regularly in task-less configuration)

## Throughput

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

### SPI @ 40MHz
### SPI @ 20MHz

* TCP - 6Mbits
* UDP - 10Mbits
Loading

0 comments on commit a5e91cf

Please sign in to comment.