Skip to content

Commit

Permalink
Rework example registration in the pack description (#31)
Browse files Browse the repository at this point in the history 
- register only high-level csolution
- remove <attributes>
- add top level README.md files
  • Loading branch information
@RobertRostohar
RobertRostohar authored Jun 28, 2024
1 parent a150365 commit d2286c1
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 156 deletions.
3 changes: 3 additions & 0 deletions Examples/Network/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Network Demo Demo

IPv4/IPv6 Client and Server applications via Ethernet
3 changes: 3 additions & 0 deletions Examples/USB/Device/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# USB Device Demo

USB Device applications using Classes HID, MSC, CDC
3 changes: 3 additions & 0 deletions Examples/USB/Host/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# USB Host Demo

USB Host applications using Classes HID, MSC
163 changes: 7 additions & 156 deletions Keil.MDK-Middleware.pdsc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1525,177 +1525,28 @@

<examples>
<example name="File System Demo" doc="File_Demo/README.md" folder="Examples/FileSystem">
<description>File manipulation example: create, read, copy, delete files on any enabled drive (SD/MMC Card, NOR/NAND Flash, RAM) and format each drive</description>
<description>Interactive application to access drives (SD/MMC Card, NOR/NAND Flash, RAM)</description>
<project>
<environment name="csolution" load="FileSystem.csolution.yml"/>
</project>
<attributes>
<component Cclass="File System" Cgroup="Drive"/>
<category>Middleware</category>
<category>File System</category>
<keyword>SD/MMC Card</keyword>
</attributes>
</example>

<example name="BSD Client IPv4/IPv6" doc="BSD_Client/README.md" folder="Examples/Network">
<description>Example using BSD sockets to send commands to remote server</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Socket" Csub="BSD"/>
<category>Middleware</category>
<category>Network</category>
<keyword>BSD</keyword>
</attributes>
</example>
<example name="BSD Server IPv4/IPv6" doc="BSD_Server/README.md" folder="Examples/Network">
<description>Example using BSD sockets to accept commands from remote clients</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Socket" Csub="BSD"/>
<category>Middleware</category>
<category>Network</category>
<keyword>BSD</keyword>
</attributes>
</example>
<example name="FTP Server IPv4/IPv6" doc="FTP_Server/README.md" folder="Examples/Network">
<description>File Server using FTP protocol with SD/MMC Memory Card as storage media</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Service" Csub="FTP Server"/>
<category>Middleware</category>
<category>Network</category>
<keyword>FTP</keyword>
</attributes>
</example>
<example name="HTTP Server IPv4/IPv6" doc="HTTP_Server/README.md" folder="Examples/Network">
<description>Compact Web Server with CGI interface</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Service" Csub="Web Server Compact"/>
<category>Middleware</category>
<category>Network</category>
<keyword>Web Server</keyword>
<keyword>HTTP</keyword>
</attributes>
</example>
<example name="HTTP Upload IPv4/IPv6" doc="HTTP_Upload/README.md" folder="Examples/Network">
<description>Web Server with CGI interface and SD/MMC Memory Card as storage media</description>
<example name="Network Demo" doc="README.md" folder="Examples/Network">
<description>IPv4/IPv6 Client and Server applications via Ethernet</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Service" Csub="Web Server"/>
<category>Middleware</category>
<category>Network</category>
<keyword>Web Server</keyword>
<keyword>HTTP</keyword>
</attributes>
</example>
<example name="SMTP Client IPv4/IPv6" doc="SMTP_Client/README.md" folder="Examples/Network">
<description>Example showing how to compose and send emails</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Service" Csub="SMTP Client"/>
<category>Middleware</category>
<category>Network</category>
<keyword>SMTP</keyword>
</attributes>
</example>
<example name="SNMP Agent IPv4/IPv6" doc="SNMP_Agent/README.md" folder="Examples/Network">
<description>Example showing how to use a Simple Network Management Protocol (SNMP)</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Service" Csub="SNMP Agent"/>
<category>Middleware</category>
<category>Network</category>
<keyword>SNMP</keyword>
</attributes>
</example>
<example name="Telnet Server IPv4/IPv6" doc="Telnet_Server/README.md" folder="Examples/Network">
<description>Command-line Host service example using Telnet protocol</description>
<project>
<environment name="csolution" load="Network.csolution.yml"/>
</project>
<attributes>
<component Cclass="Network" Cgroup="Service" Csub="Telnet Server"/>
<category>Middleware</category>
<category>Network</category>
<keyword>Telnet</keyword>
</attributes>
</example>

<example name="USB Device HID" doc="HID/README.md" folder="Examples/USB/Device">
<description>USB Human Interface Device providing access from PC to board LEDs and joystick</description>
<example name="USB Device Demo" doc="README.md" folder="Examples/USB/Device">
<description>USB Device applications using Classes HID, MSC, CDC</description>
<project>
<environment name="csolution" load="USB_Device.csolution.yml"/>
</project>
<attributes>
<component Cclass="USB" Cgroup="Device" Csub="HID"/>
<category>Middleware</category>
<category>USB Device</category>
<keyword>HID</keyword>
</attributes>
</example>
<example name="USB Device Mass Storage" doc="MassStorage/README.md" folder="Examples/USB/Device">
<description>USB Mass Storage Device using RAM as storage media</description>
<project>
<environment name="csolution" load="USB_Device.csolution.yml"/>
</project>
<attributes>
<component Cclass="USB" Cgroup="Device" Csub="MSC"/>
<category>Middleware</category>
<category>USB Device</category>
<keyword>Memory Disk</keyword>
</attributes>
</example>
<example name="USB Device Virtual COM" doc="VirtualCOM/README.md" folder="Examples/USB/Device">
<description>Bridge between PC USB Virtual COM Port and UART port</description>
<project>
<environment name="csolution" load="USB_Device.csolution.yml"/>
</project>
<attributes>
<component Cclass="USB" Cgroup="Device" Csub="CDC"/>
<category>Middleware</category>
<category>USB Device</category>
<keyword>Virtual COM</keyword>
</attributes>
</example>

<example name="USB Host Mass Storage" doc="MassStorage/README.md" folder="Examples/USB/Host">
<description>USB Host file manipulation example: create, read, copy, delete files from USB Mass Storage Device and format the storage device</description>
<project>
<environment name="csolution" load="USB_Host.csolution.yml"/>
</project>
<attributes>
<component Cclass="USB" Cgroup="Host" Csub="MSC"/>
<category>Middleware</category>
<category>USB Host</category>
<keyword>Mass Storage</keyword>
</attributes>
</example>
<example name="USB Host Keyboard" doc="Keyboard/README.md" folder="Examples/USB/Host">
<description>Measure example using USB HID Keyboard as input device</description>
<example name="USB Host Demo" doc="README.md" folder="Examples/USB/Host">
<description>USB Host applications using Classes HID, MSC</description>
<project>
<environment name="csolution" load="USB_Host.csolution.yml"/>
</project>
<attributes>
<component Cclass="USB" Cgroup="Host" Csub="HID"/>
<category>Middleware</category>
<category>USB Host</category>
<keyword>Keyboard</keyword>
</attributes>
</example>
</examples>

Expand Down

0 comments on commit d2286c1

Please sign in to comment.