Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples: update README.md #29

Merged
merged 1 commit into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Examples/Network/BSD_Client/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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.
4 changes: 2 additions & 2 deletions Examples/Network/BSD_Server/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
16 changes: 9 additions & 7 deletions Examples/Network/FTP_Server/README.md
Original file line number Diff line number Diff line change
@@ -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:
<https://www.keil.com/pack/doc/MW/Network/html/_f_t_p__server__example.html>

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://<host-name> or ftp://<IP-address>
To connect to the server, open your FTP client and enter the address:
ftp://my_host
or
ftp://\<IP-address\>

Default user : admin
Default password: <none>
Default user: admin
Default password: \<none\>
14 changes: 6 additions & 8 deletions Examples/Network/HTTPS_Server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: \<none\>
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: \<none\>

>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.

16 changes: 9 additions & 7 deletions Examples/Network/HTTP_Server/README.md
Original file line number Diff line number Diff line change
@@ -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:
<https://www.keil.com/pack/doc/MW/Network/html/_compact__web__server__example.html>

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://<host-name> or http://<IP-address>
To test this example, open your web browser and enter the address:
http://my_host
or
http://\<IP-address\>

Default user : admin
Default password: <none>
Default user: admin
Default password: \<none\>
16 changes: 9 additions & 7 deletions Examples/Network/HTTP_Upload/README.md
Original file line number Diff line number Diff line change
@@ -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:
<http://www.keil.com/pack/doc/MW/Network/html/_h_t_t_p__upload__example.html>

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://<host-name> or http://<IP-address>
To test this example, open your web browser and enter the address:
http://\<host-name\>
or
http://\<IP-address\>

Default user : admin
Default password: <none>
Default user: admin
Default password: \<none\>
27 changes: 14 additions & 13 deletions Examples/Network/SMTP_Client/README.md
Original file line number Diff line number Diff line change
@@ -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:
<https://www.keil.com/pack/doc/mw/Network/html/_s_m_t_p__client__example.html>

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
7 changes: 3 additions & 4 deletions Examples/Network/SNMP_Agent/README.md
Original file line number Diff line number Diff line change
@@ -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.
19 changes: 10 additions & 9 deletions Examples/Network/Telnet_Server/README.md
Original file line number Diff line number Diff line change
@@ -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:
<https://www.keil.com/pack/doc/MW/Network/html/_telnet__example.html>

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
Expand All @@ -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 <host-name> or
> telnet <ip-address>
telnet my_host
or
telnet \<IP-address\>

Default user : admin
Default password: <none>

Type 'help' to see the available commands or 'bye' to close the connection.
Default user: admin
Default password: \<none\>

Type *help* to see the available commands or *bye* to close the connection.
Loading