Skip to content

Commit

Permalink
Update documentation for branch main
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Oct 7, 2024
1 parent 0a6fa0f commit 025611b
Show file tree
Hide file tree
Showing 23 changed files with 99 additions and 114 deletions.
9 changes: 5 additions & 4 deletions main/FileSystem/File_Demo_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,14 +130,15 @@
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_src_example_file_demo"></a> This example shows how to manipulate files on a memory drive using the File System Component.</p>
<p>You can mount and format the drive and then perform operations like write, read, rename and delete to manage files and directories on any enabled drive. Example uses serial terminal connection to interact with the user.</p>
<p>Typically one connects the development board to a computer via debug connection that also provides virtual COM port, downloads example application to a board and starts terminal application on computer. The following picture shows an exemplary connection of the development board and a computer:</p>
<p>Typically one connects the development board to a computer via debug connection that also provides virtual COM port, downloads example application to a board and starts terminal application on computer.</p>
<p>The following picture shows an exemplary connection of the development board and a computer:</p>
<div class="image">
<img src="fs_setup.png" alt=""/>
<div class="caption">
Hardware setup of the File Demo example</div></div>
<h1><a class="anchor" id="autotoc_md1"></a>
Project Organization</h1>
<p>The File Demo project is available as part of <a class="el" href="examples.html">File System Reference examples</a>.</p>
<p>The File Demo project is available as part of the <a class="el" href="examples.html">File System Reference examples</a>.</p>
<h2>Application Source Files</h2>
<p>Following files implement application-specific logic in the example:</p>
<ul>
Expand All @@ -162,7 +163,7 @@ <h2>Software Components Configuration Files</h2>
<h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_MCI</code>: CMSIS-Driver for Memory Card Interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDIN</code>: Standard Input redirection</li>
<li><code>STDOUT</code>: Standard Output redirection</li>
</ul>
Expand All @@ -178,7 +179,7 @@ <h1><a class="anchor" id="autotoc_md2"></a>
<h1><a class="anchor" id="autotoc_md3"></a>
Run the Example</h1>
<p><b>Setup</b></p>
<p>Board-specific setup such as jumpers, SD card ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, SD card ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to the target development board.</li>
<li>Insert an SD Card to the corresponding slot on the development board.</li>
Expand Down
2 changes: 1 addition & 1 deletion main/FileSystem/footer.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ function writeHeader() {
};

function writeFooter() {
document.write('Generated on Fri Oct 4 2024 12:56:40 for File System Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
document.write('Generated on Mon Oct 7 2024 10:19:20 for File System Component 8.0.0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
};
4 changes: 2 additions & 2 deletions main/General/footer.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function writeHeader() {
document.write('Version 8.0.0-dev212');
document.write('Version 8.0.0-dev217');
};

function writeFooter() {
document.write('Generated on Fri Oct 4 2024 12:56:40 for MDK-Middleware 8.0.0-dev212+gadd6bb0. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
document.write('Generated on Mon Oct 7 2024 10:19:20 for MDK-Middleware 8.0.0-dev217+g08b985c. Copyright &copy; 2024 Arm Limited (or its affiliates). All rights reserved.');
};
4 changes: 2 additions & 2 deletions main/Network/BSD_Client_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h2>Software Components Configuration Files</h2>
<h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_ETH</code>: CMSIS-Driver for Ethernet interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDOUT</code>: Standard Output redirection</li>
</ul>
<h1><a class="anchor" id="autotoc_md35"></a>
Expand All @@ -180,7 +180,7 @@ <h1><a class="anchor" id="autotoc_md35"></a>
<h1><a class="anchor" id="autotoc_md36"></a>
Run the Example</h1>
<p><b>Setup</b></p>
<p>Board-specific setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to your development board.</li>
<li>Use an Ethernet cable to connect your development board to the local area network. The PC is assumed to be already a member of this LAN.</li>
Expand Down
4 changes: 2 additions & 2 deletions main/Network/BSD_Server_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ <h2>Software Components Configuration Files</h2>
<h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_ETH</code>: CMSIS-Driver for Ethernet interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDOUT</code>: Standard Output redirection</li>
</ul>
<h1><a class="anchor" id="autotoc_md38"></a>
Expand All @@ -180,7 +180,7 @@ <h1><a class="anchor" id="autotoc_md38"></a>
<h1><a class="anchor" id="autotoc_md39"></a>
Run the Example</h1>
<p><b>Hardware Setup</b></p>
<p>Board-specific setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to your development board.</li>
<li>You can setup two development boards within the same network: a BSD server and a BSD client.</li>
Expand Down
4 changes: 2 additions & 2 deletions main/Network/FTP_Server_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following CMSIS-Driver interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_ETH</code>: CMSIS-Driver for Ethernet interface</li>
<li><code>CMSIS_MCI</code>: CMSIS-Driver for Memory Card Interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDOUT</code>: Standard Output redirection</li>
</ul>
<h1><a class="anchor" id="autotoc_md20"></a>
Expand All @@ -190,7 +190,7 @@ <h1><a class="anchor" id="autotoc_md20"></a>
<h1><a class="anchor" id="autotoc_md21"></a>
Run the Example</h1>
<p><b>Setup</b></p>
<p>Board-specific setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to the target development board.</li>
<li>Use an Ethernet cable to connect your development board to the local area network. The PC is assumed to be already a member of this LAN.</li>
Expand Down
7 changes: 4 additions & 3 deletions main/Network/HTTPS_Server_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,8 @@
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_src_example_https_server"></a> This example implements an HTTPS Server on a device that can be accessed from a computer connected to the same network.</p>
<p>The HTTPS server uses the ARM mbed TLS software component to enable <a class="el" href="secure_communication.html">Secure Communication</a>.</p>
<p>The example uses a fixed set of web pages stored in ROM, but is capable of exchanging information with the underlying hardware by using the CGI interface. The following picture shows an exemplary connection of the development board and a Computer.</p>
<p>The example uses a fixed set of web pages stored in ROM, but is capable of exchanging information with the underlying hardware by using the CGI interface.</p>
<p>The following picture shows an exemplary connection of the development board and a Computer.</p>
<div class="image">
<img src="cws_setup.png" alt=""/>
<div class="caption">
Expand Down Expand Up @@ -179,7 +180,7 @@ <h2>Software Components Configuration Files</h2>
<h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_ETH</code>: CMSIS-Driver for Ethernet interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDOUT</code>: Standard Output redirection</li>
</ul>
<h1><a class="anchor" id="autotoc_md14"></a>
Expand All @@ -194,7 +195,7 @@ <h1><a class="anchor" id="autotoc_md14"></a>
<h1><a class="anchor" id="autotoc_md15"></a>
Run the Example</h1>
<p><b>Setup</b></p>
<p>Board-specific setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to the target development board.</li>
<li>Use an Ethernet cable to connect your development board to the local area network. The PC is assumed to be already in this LAN.</li>
Expand Down
7 changes: 4 additions & 3 deletions main/Network/HTTP_Server_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_src_example_http_server"></a> This example implements an HTTP Server on a device that can be accessed from a computer via network interface.</p>
<p>The example uses a fixed set of web pages stored in ROM, but is capable of exchanging information with the underlying hardware by using the CGI interface. The following picture shows an exemplary connection of the development board and a Computer.</p>
<p>The example uses a fixed set of web pages stored in ROM, but is capable of exchanging information with the underlying hardware by using the CGI interface.</p>
<p>The following picture shows an exemplary connection of the development board and a Computer.</p>
<div class="image">
<img src="cws_setup.png" alt=""/>
<div class="caption">
Expand Down Expand Up @@ -173,7 +174,7 @@ <h2>Software Components Configuration Files</h2>
<h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_ETH</code>: CMSIS-Driver for Ethernet interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDOUT</code>: standard output stream redirection</li>
</ul>
<h1><a class="anchor" id="autotoc_md11"></a>
Expand All @@ -188,7 +189,7 @@ <h1><a class="anchor" id="autotoc_md11"></a>
<h1><a class="anchor" id="autotoc_md12"></a>
Run the Example</h1>
<p><b>Setup</b></p>
<p>Board-specific setup such as jumpers, Ethernet ports, power supply, etc is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, Ethernet ports, power supply, etc is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to the target development board.</li>
<li>Use an Ethernet cable to connect your development board to the local area network. The PC is assumed to be already in this LAN.</li>
Expand Down
7 changes: 4 additions & 3 deletions main/Network/HTTP_Upload_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,8 @@
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_src_example_http_upload"></a> The HTTP Upload example implements a web based interface to an SD card attached to a development board.</p>
<p>The user is able to list the contents of the memory card and to upload files to it. The following picture shows an exemplary connection of the development board and a Computer.</p>
<p>The user is able to list the contents of the memory card and to upload files to it.</p>
<p>The following picture shows an exemplary connection of the development board and a Computer.</p>
<div class="image">
<img src="http_upload_setup.png" alt=""/>
<div class="caption">
Expand Down Expand Up @@ -172,7 +173,7 @@ <h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_ETH</code>: CMSIS-Driver for Ethernet interface</li>
<li><code>CMSIS_MCI</code>: CMSIS-Driver for Memory Card Interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDOUT</code>: Standard Output redirection</li>
</ul>
<h1><a class="anchor" id="autotoc_md17"></a>
Expand All @@ -187,7 +188,7 @@ <h1><a class="anchor" id="autotoc_md17"></a>
<h1><a class="anchor" id="autotoc_md18"></a>
Run the Example</h1>
<p><b>Setup</b></p>
<p>Board-specific setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to the target development board.</li>
<li>Use an Ethernet cable to connect your development board to the local area network. The PC is assumed to be already in this LAN.</li>
Expand Down
7 changes: 4 additions & 3 deletions main/Network/SMTPS_Client_Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,8 @@
<div class="headertitle"><div class="title">SMTPS Client </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><a class="anchor" id="md_src_example_smtps_client"></a> SMTPS is used to send secure e-mail notifications from an embedded system to various recipients. This example shows how to setup an SMTPS client for this purpose. The following picture shows an exemplary connection of the development board and a Computer.</p>
<div class="textblock"><p><a class="anchor" id="md_src_example_smtps_client"></a> SMTPS is used to send secure e-mail notifications from an embedded system to various recipients. This example shows how to setup an SMTPS client for this purpose.</p>
<p>The following picture shows an exemplary connection of the development board and a Computer.</p>
<div class="image">
<img src="smtp_setup.png" alt=""/>
<div class="caption">
Expand Down Expand Up @@ -183,7 +184,7 @@ <h2>Software Components Configuration Files</h2>
<h2>Board Layer</h2>
<p>In order to build the project it shall be extended with a compatible board layer that provides following interfaces as <a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/ReferenceApplications.md#connections">connections</a>:</p><ul>
<li><code>CMSIS_ETH</code>: CMSIS-Driver for Ethernet interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for virtual I/O interface</li>
<li><code>CMSIS_VIO</code>: CMSIS-Driver for Virtual I/O interface</li>
<li><code>STDOUT</code>: Standard Output redirection</li>
</ul>
<h1><a class="anchor" id="autotoc_md29"></a>
Expand All @@ -198,7 +199,7 @@ <h1><a class="anchor" id="autotoc_md29"></a>
<h1><a class="anchor" id="autotoc_md30"></a>
Run the Example</h1>
<p><b>Setup</b></p>
<p>Board-specific setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<p>Board-specific hardware setup such as jumpers, Ethernet ports, power supply, etc. is documented in the board layer description (<code>README.md</code>) of your selected target.</p>
<ol type="1">
<li>Load the executable image to the target development board.</li>
<li>Use an Ethernet cable to connect your development board to the local area network. The PC is assumed to be already in this LAN.</li>
Expand Down
Loading

0 comments on commit 025611b

Please sign in to comment.