7.4.0

Author: quantum-leaps

README.md

@@ -2,18 +2,24 @@
 [![Quantum Leaps](https://www.state-machine.com/attachments/logo_ql_400.png)](https://www.state-machine.com)
 <hr>
 
-[![GitHub release (latest by date)](https://img.shields.io/github/v/release/QuantumLeaps/qpc-examples)](https://github.com/QuantumLeaps/qpc-examples/releases/latest)
+# About qpc-examples
+This repository contains the application examples for the QP/C
+Real-Time Embedded Framework (see https://github.com/QuantumLeaps/qpc ).
 
+This repository can be used in several ways:
+- [Standalone examples](#standalone-examples-in-the-cmsis-packs-folder)
+  that don't require the [qpc framework repo](https://github.com/QuantumLeaps/qpc).
+  (These examples rely on the qpc framework included from the
+  [CMIS-packs](https://github.com/QuantumLeaps/cmsis-packs))
 
-# About qpc-examples
+- [As a sub-module to the qpc repo](#as-a-sub-module-to-the-qpc-repository)
 
-This repository contains examples for the QP/C Real-Time Embedded Framework
-(see https://github.com/QuantumLeaps/qpc )
+- [Examples for the QView monitoring system](#examples-for-qview-monitoring-system)
 
-This repository can be used in two ways:
+- [Examples for the QUTest testing system](#examples-for-qtest-testing-system)
 
-## Standalone (examples in the `cmsis-packs` folder)
 
+## Standalone (examples in the `cmsis-packs` folder)
 ```
 +---cmsis-packs    <=== standalone examples
 |   +---dpp_nucleo-c031c6-qk-gcc
@@ -22,8 +28,7 @@ This repository can be used in two ways:
 |
 ```
 
-## As a sub-module to the [qpc](https://github.com/QuantumLeaps/qpc) repository
-
+## As a sub-module to the qpc repository
 ```
 +---arm-cm
 |   +---blinky_ek-tm4c123gxl
@@ -52,6 +57,7 @@ This repository can be used in two ways:
 |   +---dpp_nucleo-l053r8
 |   +---dpp_nucleo-l152re
 |   +---dpp_nucleo-l552ze
+|   +---dpp_nucleo-u545re
 |   +---dpp_stm32f4-discovery
 |   +---game_efm32-slstk3401a
 |   +---low-power_ek-tm4c123gxl
@@ -79,10 +85,7 @@ This repository can be used in two ways:
 |   +---blinky_msp-exp430g2
 |   \---dpp_msp-exp430f5529lp
 |
-+---pic32
-|   \---dpp_microstick2-pic32
-|
-+---posix-win32
++---posix-win32   <== examples for the host computer
 |   +---blinky
 |   +---calc
 |   +---calc2
@@ -99,7 +102,7 @@ This repository can be used in two ways:
 |   +---reminder
 |   \---reminder2
 |
-+---qutest
++---qutest    <== examples for QUTest testing harness
 |   +---blinky
 |   +---dpp
 |   +---dpp-comp
@@ -117,18 +120,66 @@ This repository can be used in two ways:
 |       +---src
 |       \---test
 |
-+---qwin-gui
-|   +---dpp-gui
-|   \---game-gui
-|
 +---threadx
 |   \---arm-cm
 |       +---dpp_ek-tm4c123gxl
 |       \---dpp_stm32f429-discovery
 +---uc-os2
 |   \---arm-cm
 |       \---dpp_ek-tm4c123gxl
-\---zephyr
-    +---blinky
-    \---dpp
++---zephyr
+|   +---blinky
+|   \---dpp
+|
++---qview-dpp  <== examples for the QView monitoring system
+|   +---img
+|       dpp.py
+|
++---qwin-gui   <== examples for the QWin GUI
+|   +---dpp-gui
+|   \---game-gui
+|
 ```
+
+## Examples for QView Monitoring System
+The "qview" Python package (included in the
+[QTools collection](https://github.com/QuantumLeaps/qtools))
+is a powerful
+[Visualization and Monitoring system](https://www.state-machine.com/qtools/qview.html),
+which allows embedded developers to create virtual Graphical User Interfaces
+in Python to monitor and control their embedded devices from a host (desktop)
+computer. The interfaces created by QView can visualize the data produced
+by [QP/Spy software tracing system](https://www.state-machine.com/qtools/qpspy.html)
+and can also interact with the embedded target by sending various commands.
+
+The python scripts `qview-dpp/dpp.py` and `qview-dpp/dpp1.py` will allow
+monitoring of all DPP examples running on any supported board (or on the
+host computer). Here is how you can launch the QView monitoring for DPP:
+
+```
+python %QTOOLS%\qview\qview.py dpp.py
+```
+
+> **NOTE** You need the `qview.py` Python script, which in the command-line
+above is assumed to be located in `%QTOOLS%\qview`.
+
+The following screen shot shows QView for the DPP (Dining Philosophers Problem)
+application with the QSPY ouptut in the background.
+
+![](qview-dpp/img/qview-dpp.webp)
+
+
+## Examples for QTest Testing System
+The "qutest" Python package  (included in the
+[QTools collection](https://github.com/QuantumLeaps/qtools))
+is a powerful [testing system](https://www.state-machine.com/qtools/qutest.html).
+It has been specifically designed for deeply embedded systems, but also supports
+unit and integration testing of embedded code on host computers ("dual targeting").
+QUTest is the fundamental tooling for Test-Driven Development (TDD) and Behavior-
+Driven Development (BDD) of QP/C/C++ applications , which is a highly recommended
+best-practice.
+
+The following screen shot show a typical QUTest run with the QSPY ouptut
+in the background.
+
+![](qutest/img/qutest-dpp.webp)