Skip to content

Commit

Permalink
Merge branch 'docs/fix_a_copy_paste_error' into 'master'
Browse files Browse the repository at this point in the history
fix copy paste error

See merge request sdk/ESP8266_RTOS_SDK!1695
  • Loading branch information
donghengqaz committed Aug 26, 2024
2 parents d3a5f99 + f3ca4f8 commit 199e520
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 21 deletions.
11 changes: 4 additions & 7 deletions examples/protocols/sockets/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# BSD Socket API Examples

This directory contains simple examples demonstrating BSD Socket API.
This directory contains simple examples demonstrating BSD Socket API.
Each example, contains README.md file with mode detailed informations about that particular example.
For more general informations about all examples, see the README.md file in the upper level 'examples' directory.
Examples:
Expand All @@ -26,8 +26,8 @@ http://wiki.treck.com/Introduction_to_BSD_Sockets

## Host tools

There are many host-side tools which can be used to interact with the UDP/TCP server/client example.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
There are many host-side tools which can be used to interact with the UDP/TCP server/client example.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
Note: please replace `192.168.0.167 3333` with desired IPV4/IPV6 address (displayed in monitor console) and port number in the following commands.

In addition to those tools, simple Python scripts can be found under sockets/scripts directory. Every script is designed to interact with one of the examples.
Expand Down Expand Up @@ -74,7 +74,7 @@ IPV6 = 'FE80::32AE:A4FF:FE80:5288'

## Hardware Required

This example can be run on any commonly available ESP32 development board.
This example can be run on any commonly available ESP8266 development board.

## Configure the project

Expand All @@ -97,6 +97,3 @@ make -j4 flash monitor
(To exit the serial monitor, type ``Ctrl-]``.)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.



6 changes: 3 additions & 3 deletions examples/protocols/sockets/tcp_client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The application creates a TCP socket and tries to connect to the server with pre

In order to create TCP server that communicates with TCP Client example, choose one of the following options.

There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
Note: please replace `192.168.0.167 3333` with desired IPV4/IPV6 address (displayed in monitor console) and port number in the following command.

In addition to those tools, simple Python scripts can be found under sockets/scripts directory. Every script is designed to interact with one of the examples.
Expand All @@ -30,7 +30,7 @@ PORT = 3333;

## Hardware Required

This example can be run on any commonly available ESP32 development board.
This example can be run on any commonly available ESP8266 development board.

## Configure the project

Expand Down
6 changes: 3 additions & 3 deletions examples/protocols/sockets/tcp_server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The application creates a TCP socket with the specified port number and waits fo

In order to create TCP client that communicates with TCP server example, choose one of the following options.

There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
Note: please replace `192.168.0.167 3333` with desired IPV4/IPV6 address (displayed in monitor console) and port number in the following command.

In addition to those tools, simple Python scripts can be found under sockets/scripts directory. Every script is designed to interact with one of the examples.
Expand All @@ -32,7 +32,7 @@ IPV6 = 'FE80::32AE:A4FF:FE80:5288'

## Hardware Required

This example can be run on any commonly available ESP32 development board.
This example can be run on any commonly available ESP8266 development board.

## Configure the project

Expand Down
6 changes: 3 additions & 3 deletions examples/protocols/sockets/udp_client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The application creates UDP socket and sends message to the predefined port and

In order to create UDP server that communicates with UDP Client example, choose one of the following options.

There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
Note: please replace `192.168.0.167 3333` with desired IPV4/IPV6 address (displayed in monitor console) and port number in the following commands.

In addition to those tools, simple Python scripts can be found under sockets/scripts directory. Every script is designed to interact with one of the examples.
Expand Down Expand Up @@ -40,7 +40,7 @@ PORT = 3333;

## Hardware Required

This example can be run on any commonly available ESP32 development board.
This example can be run on any commonly available ESP8266 development board.

## Configure the project

Expand Down
6 changes: 3 additions & 3 deletions examples/protocols/sockets/udp_server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The application creates UDP socket with the specified port number and waits for

In order to create UDP client that communicates with UDP server example, choose one of the following options.

There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
There are many host-side tools which can be used to interact with the UDP/TCP server/client.
One command line tool is [netcat](http://netcat.sourceforge.net) which can send and receive many kinds of packets.
Note: please replace `192.168.0.167 3333` with desired IPV4/IPV6 address (displayed in monitor console) and port number in the following commands.

In addition to those tools, simple Python scripts can be found under sockets/scripts directory. Every script is designed to interact with one of the examples.
Expand Down Expand Up @@ -42,7 +42,7 @@ IPV6 = 'FE80::32AE:A4FF:FE80:5288'

## Hardware Required

This example can be run on any commonly available ESP32 development board.
This example can be run on any commonly available ESP8266 development board.

## Configure the project

Expand Down
2 changes: 1 addition & 1 deletion examples/provisioning/legacy/custom_config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Also, it uses a component provided with this example `custom_provisioning` which

### Hardware Required

Example should be able to run on any commonly available ESP32 development board.
Example should be able to run on any commonly available ESP8266 development board.

### Application Required

Expand Down
2 changes: 1 addition & 1 deletion examples/provisioning/legacy/softap_prov/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This example can be used, as it is, for adding a provisioning service to any app

### Hardware Required

Example should be able to run on any commonly available ESP32 development board.
Example should be able to run on any commonly available ESP8266 development board.

### Application Required

Expand Down

0 comments on commit 199e520

Please sign in to comment.