-
Notifications
You must be signed in to change notification settings - Fork 145
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(wifi_remote): Cleanup the READMEs
- Loading branch information
1 parent
e20eda6
commit f47912e
Showing
3 changed files
with
36 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,21 @@ | ||
# WiFi remote EPPP RPC server | ||
|
||
# Wi-Fi station to PPPoS server | ||
This is a standalone application serving as the slave device for `esp_wifi_remote` users (with `eppp` RPC). | ||
|
||
This example demonstrate using NAPT to bring connectivity from WiFi station to PPPoS server. | ||
## Overview | ||
|
||
This example expect a PPPoS client to connect to the server and use the connectivity. | ||
The client could be a Linux computer with `pppd` service or another microcontroller with PPP client (or another ESP32 with not WiFi interface) | ||
You need to configure and connect a slave device to the `esp_wifi_remote` host and run this application. Please fallow carefully these guidelines on HW connection and configuration of the slave device, based on the host device. | ||
|
||
## HW connection | ||
|
||
We currently support only `UART` transport you just need to connect Rx, Tx and GND and configure these fields accordingly: | ||
* CONFIG_ESP_WIFI_REMOTE_EPPP_UART_TX_PIN | ||
* CONFIG_ESP_WIFI_REMOTE_EPPP_UART_RX_PIN | ||
|
||
## SW configuration | ||
|
||
You will have to install server side certificates and keys, as well as the CA which should verify the client side. | ||
Please configure these options: | ||
* CONFIG_ESP_WIFI_REMOTE_EPPP_CLIENT_CA | ||
* CONFIG_ESP_WIFI_REMOTE_EPPP_SERVER_CRT | ||
* CONFIG_ESP_WIFI_REMOTE_EPPP_SERVER_KEY |