Skip to content

Commit c0e7d19

Browse files
authored
Merge pull request #38 from MDK-Packs/feature_roadmap_update
Updated the feature roadmap
2 parents db68bc3 + a27dee7 commit c0e7d19

File tree

8 files changed

+38
-8
lines changed

8 files changed

+38
-8
lines changed

docs/debug.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,22 @@ You can add expressions to the **LIVE WATCH** by:
239239
1. Pressing the `+` sign and entering an expression.
240240
2. Using the context menu item **Add to Live Watch** in the editor or the the **Run and Debug** view.
241241

242-
![Displaying a variable in the LIVE WATCH](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main//images/lw-counter.gif)
242+
![Displaying a variable in the LIVE WATCH](./images/cmsis-debugger/lw-counter.gif)
243+
244+
#### COMPONENT VIEWER
245+
246+
This view shows detailed information and helps to analyze the operation of software components. The required
247+
infrastructure can be easily added to user applications.
248+
249+
Refer to the [Component Viewer documentation](https://arm-software.github.io/CMSIS-View/latest/cmp_viewer.html) for
250+
detailed advice on how to show information from user software using using an SCVD file.
251+
252+
The Component Viewer shows information about:
253+
254+
- Information from software components that is provided in memory for example by static variables or structures.
255+
- Objects that are addressed by an object handles or dynamic arrays.
256+
257+
![Showing software component properties in the COMPONENT VIEWER](./images/cmsis-debugger/component-viewer.png)
243258

244259
### PERIPHERALS
245260

docs/featureroadmap.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
| 🟢 [File groups](./userinterface.md#cmsis-view) | Logical grouping of source, header, and library files |
1515
| 🟢 [Layer support](./create_app.md#configuration) | Easily retarget hardware connections |
1616
| 🟢 [Software components](./create_app.md#software-components-and-packs) | Manage software components on a project/layer level |
17-
| 🟡 Manage packs | Manage CMSIS-Packs and versions graphically |
17+
| 🟢 [Manage packs](./create_app.md#manage-software-packs) | Manage CMSIS-Packs and versions graphically |
1818
| 🟢 [Zephyr project support](./zephyr.md) | Build and debug Zephyr-based applications |
1919
| 🟢 [Configuration Wizard](./userinterface.md#configuration-wizard) | GUI-assisted generation and modification of configuration code |
2020

@@ -106,7 +106,7 @@
106106

107107
| Category | Debug Features |
108108
| -------------------------- | ----------------------- |
109-
| 🟡 Component Viewer | Display and live update |
109+
| 🟢 [Component Viewer](./debug.md#component-viewer) | Display and live update |
110110
| 🟡 Event Recorder | Show event information |
111111
| 🟡 Event Recorder | Save/log |
112112
| 🟡 Event Recorder | Event filtering |
120 KB
Loading

site/debug.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,10 @@
9595
<li class="toctree-l3"><a class="reference internal" href="#cpu-time">CPU Time</a>
9696
</li>
9797
<li class="toctree-l3"><a class="reference internal" href="#trace-and-live-view">Trace and Live view</a>
98+
<ul>
99+
<li class="toctree-l4"><a class="reference internal" href="#component-viewer">COMPONENT VIEWER</a>
100+
</li>
101+
</ul>
98102
</li>
99103
<li class="toctree-l3"><a class="reference internal" href="#peripherals">PERIPHERALS</a>
100104
</li>
@@ -447,7 +451,18 @@ <h3 id="trace-and-live-view">Trace and Live view</h3>
447451
<li>Pressing the <code>+</code> sign and entering an expression.</li>
448452
<li>Using the context menu item <strong>Add to Live Watch</strong> in the editor or the the <strong>Run and Debug</strong> view.</li>
449453
</ol>
450-
<p><img alt="Displaying a variable in the LIVE WATCH" src="https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/raw/main//images/lw-counter.gif" /></p>
454+
<p><img alt="Displaying a variable in the LIVE WATCH" src="images/cmsis-debugger/lw-counter.gif" /></p>
455+
<h4 id="component-viewer">COMPONENT VIEWER</h4>
456+
<p>This view shows detailed information and helps to analyze the operation of software components. The required
457+
infrastructure can be easily added to user applications.</p>
458+
<p>Refer to the <a href="https://arm-software.github.io/CMSIS-View/latest/cmp_viewer.html">Component Viewer documentation</a> for
459+
detailed advice on how to show information from user software using using an SCVD file.</p>
460+
<p>The Component Viewer shows information about:</p>
461+
<ul>
462+
<li>Information from software components that is provided in memory for example by static variables or structures.</li>
463+
<li>Objects that are addressed by an object handles or dynamic arrays.</li>
464+
</ul>
465+
<p><img alt="Showing software component properties in the COMPONENT VIEWER" src="images/cmsis-debugger/component-viewer.png" /></p>
451466
<h3 id="peripherals">PERIPHERALS</h3>
452467
<p>The <strong>PERIPHERALS</strong> view shows the device peripheral registers and allows to change their values. It uses the CMSIS-SVD files that are provided by silicon vendors and distributed as part of the CMSIS Device Family Packs (DFP).</p>
453468
<p><img alt="Peripheral Inspector" src="images/cmsis-debugger/peripheral-inspector.png" /></p>

site/featureroadmap.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ <h3 id="project-creation-and-organization">Project creation and organization</h3
201201
<td>Manage software components on a project/layer level</td>
202202
</tr>
203203
<tr>
204-
<td>&#128993; Manage packs</td>
204+
<td>&#128994; <a href="create_app.html#manage-software-packs">Manage packs</a></td>
205205
<td>Manage CMSIS-Packs and versions graphically</td>
206206
</tr>
207207
<tr>
@@ -481,7 +481,7 @@ <h3 id="component-viewer-and-event-recorder">Component Viewer and Event Recorder
481481
</thead>
482482
<tbody>
483483
<tr>
484-
<td>&#128993; Component Viewer</td>
484+
<td>&#128994; <a href="debug.html#component-viewer">Component Viewer</a></td>
485485
<td>Display and live update</td>
486486
</tr>
487487
<tr>
120 KB
Loading

site/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,5 +272,5 @@ <h2 id="revision-history">Revision history</h2>
272272

273273
<!--
274274
MkDocs version : 1.6.1
275-
Build Date UTC : 2026-02-27 09:27:57.001887+00:00
275+
Build Date UTC : 2026-02-27 11:11:19.285038+00:00
276276
-->

site/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)