From 64f0b03f4badeb7fcaf0804ceadf15f6d86e4839 Mon Sep 17 00:00:00 2001 From: Franc Urbanc Date: Fri, 21 Jun 2024 12:01:51 +0200 Subject: [PATCH] Examples: update Network README.md files --- Examples/Network/BSD_Client/README.md | 6 +++--- Examples/Network/BSD_Server/README.md | 4 ++-- Examples/Network/FTP_Server/README.md | 16 ++++++++------ Examples/Network/HTTPS_Server/README.md | 14 ++++++------ Examples/Network/HTTP_Server/README.md | 16 ++++++++------ Examples/Network/HTTP_Upload/README.md | 16 ++++++++------ Examples/Network/SMTP_Client/README.md | 27 ++++++++++++------------ Examples/Network/SNMP_Agent/README.md | 7 +++--- Examples/Network/Telnet_Server/README.md | 19 +++++++++-------- 9 files changed, 65 insertions(+), 60 deletions(-) diff --git a/Examples/Network/BSD_Client/README.md b/Examples/Network/BSD_Client/README.md index 1d646566..59bc5a2e 100644 --- a/Examples/Network/BSD_Client/README.md +++ b/Examples/Network/BSD_Client/README.md @@ -1,4 +1,4 @@ -This program is an example of a BSD client. It shows you how to control the LEDs +This program is an example of a **BSD client**. It shows you how to control the LEDs on the evaluation board of the server via the BSD socket. To run this example, you must use the automatically assigned IPv6 address or set @@ -9,5 +9,5 @@ Download a BSD server and start it on another evaluation board connected to the same LAN. When BSD client is running, the LED diodes on both evaluation boards should light up synchronously. -NOTE: The IPv4 address and MAC address in this example must be different - from the IPv4 and MAC addresses on the BSD server. +>The IPv4 address and MAC address in this example must be different from the IPv4 +and MAC addresses on the BSD server. diff --git a/Examples/Network/BSD_Server/README.md b/Examples/Network/BSD_Server/README.md index 53761544..203c4fb7 100644 --- a/Examples/Network/BSD_Server/README.md +++ b/Examples/Network/BSD_Server/README.md @@ -1,11 +1,11 @@ -This program is an example of a BSD server. It is used to serve LED control +This program is an example of a **BSD server**. It is used to serve LED control requests from BSD clients. To run this example, you must use the automatically assigned IPv6 address or set the IPv4 address to match your local network, otherwise the server cannot be reached. This is because the requests for non-LAN hosts are forwarded to the default gateway. -To test this example, start the Windows application "LEDSwitch.exe" on your PC. +To test this example, start the Windows application *LEDSwitch.exe* on your PC. Enter the IP address and the port of the server and select the transmission protocol TCP or UDP. If you change the value of P2 in the Windows application, the LED diodes on the evaluation board should light up accordingly. diff --git a/Examples/Network/FTP_Server/README.md b/Examples/Network/FTP_Server/README.md index 90ff507e..d1b06640 100644 --- a/Examples/Network/FTP_Server/README.md +++ b/Examples/Network/FTP_Server/README.md @@ -1,15 +1,17 @@ -This program is an example of an FTP server. It allows you to manage +This program is an example of an **FTP server**. It allows you to manage files on your SD card from your PC using an FTP client. -Detailed description is available on: -www.keil.com/pack/doc/MW/Network/html/_f_t_p__server__example.html +Detailed description is available on: + Use this example to connect an evaluation board to a LAN with a router. You can also connect an evaluation board directly to a PC using a direct or crossover network cable. -To connect to the server, open your FTP client and enter the address: -ftp:// or ftp:// +To connect to the server, open your FTP client and enter the address: +ftp://my_host +or +ftp://\ -Default user : admin -Default password: +Default user: admin +Default password: \ diff --git a/Examples/Network/HTTPS_Server/README.md b/Examples/Network/HTTPS_Server/README.md index b2025b7d..bdafd8f2 100644 --- a/Examples/Network/HTTPS_Server/README.md +++ b/Examples/Network/HTTPS_Server/README.md @@ -8,16 +8,14 @@ You can also connect an evaluation board directly to a PC using a direct or crossover network cable. To test this example, open your web browser and enter the address: -> https://my_host -> -> Default user: admin -> Default password: \ +https://my_host -Note for Windows users: -You must add the test CA certificate **ca.crt** to the Trusted Root Certificate store on your computer -to avoid the *Your connection is not private* error in the Chrome or Microsoft Edge browser. +Default user: admin +Default password: \ +>Note for Windows users: +You must add the test CA certificate **ca.crt** to the Trusted Root Certificate store on your computer +to avoid the *Your connection is not private* error in the Chrome or Microsoft Edge browser. To install a **ca.crt** certificate on your computer, double-click on it and select **Install Certificate...**, then select **Local Machine** for the store location. You need administrator rights for this action. Select **Trusted Root Certification Authorities** as the location for the certificate. - diff --git a/Examples/Network/HTTP_Server/README.md b/Examples/Network/HTTP_Server/README.md index d10e0090..829f94ba 100644 --- a/Examples/Network/HTTP_Server/README.md +++ b/Examples/Network/HTTP_Server/README.md @@ -1,14 +1,16 @@ -This program is a Compact Web Server example. +This program is a **Compact Web Server** example. -Detailed description is available on: -www.keil.com/pack/doc/MW/Network/html/_compact__web__server__example.html +Detailed description is available on: + Use this example to connect an evaluation board to a LAN with a router. You can also connect an evaluation board directly to a PC using a direct or crossover network cable. -To test this example, open your web browser and enter the -address http:// or http:// +To test this example, open your web browser and enter the address: +http://my_host +or +http://\ -Default user : admin -Default password: +Default user: admin +Default password: \ diff --git a/Examples/Network/HTTP_Upload/README.md b/Examples/Network/HTTP_Upload/README.md index 4dbf1970..aa455e24 100644 --- a/Examples/Network/HTTP_Upload/README.md +++ b/Examples/Network/HTTP_Upload/README.md @@ -1,15 +1,17 @@ -This program is an example of a web server upload. It shows you how to upload +This program is an example of a web server **upload**. It shows you how to upload files to an SD card via a web browser. -Detailed description is available on: -http://www.keil.com/pack/doc/MW/Network/html/_h_t_t_p__upload__example.html +Detailed description is available on: + Use this example to connect an evaluation board to a LAN with a router. You can also connect an evaluation board directly to a PC using a direct or crossover network cable. -To test this example, open your web browser and enter the -address http:// or http:// +To test this example, open your web browser and enter the address: +http://\ +or +http://\ -Default user : admin -Default password: +Default user: admin +Default password: \ diff --git a/Examples/Network/SMTP_Client/README.md b/Examples/Network/SMTP_Client/README.md index 2367db61..cbdb63f1 100644 --- a/Examples/Network/SMTP_Client/README.md +++ b/Examples/Network/SMTP_Client/README.md @@ -1,23 +1,24 @@ -This program is an example of an SMTP client. It shows you how to send e-mails +This program is an example of an **SMTP client**. It shows you how to send e-mails from an embedded application. +Detailed description is available on: + + To test this example, connect the evaluation board to a LAN with a router. The example will automatically configure the network parameters. -Note: -For the example to work, you must change SMTP_Client.c: +Note: +For the example to work, you must change *SMTP_Client.c* - Change the content of the email information in the SMTP email - descriptor structure (NET_SMTP_MAIL mail): - - Email addresses: From, To, Cc, Bcc - - Subject and the message (body) of the email - - Optional attachments and encoding type + descriptor structure (*NET_SMTP_MAIL mail*): + - Email addresses: *From*, *To*, *Cc*, *Bcc* + - Subject and the message (body) of the email + - Optional attachments and encoding type - Change the information about the SMTP server and the user credentials - in the SMTP Mail Transfer Agent Descriptor structure (NET_SMTP_MTA Server): - - Server name/IP - - Server port - - User name and password - - Optional NET_SMTP_MTA_USETLS flag in the case of a secure variant. - (https://www.keil.com/pack/doc/mw/Network/html/use_secure_components.html#smtps_client) + in the SMTP Mail Transfer Agent Descriptor structure (*NET_SMTP_MTA Server*): + - Server name/IP + - Server port + - User name and password - Provide an Internet network connection diff --git a/Examples/Network/SNMP_Agent/README.md b/Examples/Network/SNMP_Agent/README.md index a3609db2..38b0de3e 100644 --- a/Examples/Network/SNMP_Agent/README.md +++ b/Examples/Network/SNMP_Agent/README.md @@ -1,12 +1,11 @@ -This program is an SNMP Agent example. It shows how to use a Simple Network +This program is an **SNMP Agent** example. It shows how to use a Simple Network Management Protocol is used to control the embedded system. Use this example to connect an evaluation board to a LAN with a DHCP server (most LANs have one). This example automatically configures the network parameters via a DHCP protocol. -To test this example, run the Windows application 'SNMPTest.exe' on your PC. +To test this example, run the Windows application *SNMPTest.exe* on your PC. Enter the IP address of your embedded SNMP_Agent and click on 'Connect'. Once the connection is established, you can change the LCD text on the target device, -control the built-in LED diodes and monitor the status of the built-in pushbuttons. - +control the built-in LED diodes and monitor the status of the built-in push-buttons. diff --git a/Examples/Network/Telnet_Server/README.md b/Examples/Network/Telnet_Server/README.md index 31a9a11f..18d8b7a5 100644 --- a/Examples/Network/Telnet_Server/README.md +++ b/Examples/Network/Telnet_Server/README.md @@ -1,7 +1,8 @@ -This is a Telnet_Server example running on Network Dual Stack. +This is a **Telnet Server** example. It shows you how to set up a command line +interface within an embedded application. -Detailed description is available on: -www.keil.com/pack/doc/MW/Network/html/_telnet__example.html +Detailed description is available on: + Use this example to connect an evaluation board to a LAN with a router. You can also connect an evaluation board directly to a PC using a direct or @@ -11,11 +12,11 @@ To test this example, run a Telnet client on your PC. If you are using the Windows Telnet client, you can establish the connection with the following command in the console window: -> telnet or -> telnet +telnet my_host +or +telnet \ -Default user : admin -Default password: - -Type 'help' to see the available commands or 'bye' to close the connection. +Default user: admin +Default password: \ +Type *help* to see the available commands or *bye* to close the connection.