Skip to content

Commit cf38676

Browse files
committed
6.9.4
Updated README.md with the information about QP/Spy support
1 parent 0c12d5c commit cf38676

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,11 +116,36 @@ it is re-generated by the QM modeling tool.
116116

117117

118118
----
119-
# Example Documentation
119+
## Example Documentation
120120

121121
Each example model has documentation, which you can view in the QM tool.
122122
The model documentation shows in the Property Editor when the model item
123123
is active.
124+
125+
----
126+
# QP/Spy Software Tracing Support
127+
128+
The qpcpp_arm-cm library now supports the
129+
[QP/Spy software tracing](https://www.state-machine.com/software-tracing).
130+
This feature is also demonstrated in the qpcpp examples (with the BSP).
131+
132+
To activate the software tracing, you would need to un-comment the `QS_ON`
133+
macro at the top of bsp.cpp source file.
134+
135+
> **NOTE:** Because the QP/Spy output is binary, you cannot watch it
136+
with a standard serial terminal. Instead, you need to use the
137+
[QSPY host utility](https://www.state-machine.com/qtools/qspy.html).
138+
139+
----
140+
## QView Demonstration
141+
Once QP/Spy tracing is enabled, this communication with the target system
142+
can be used to for
143+
[QView visualization and monitoring](https://www.state-machine.com/qtools/qview.html)
144+
145+
The `dpp_bsp-sam` example demonstrates the [QView monitoring]. To see this
146+
feture, you need to upload the dpp_bsp-sam code to the Arduino UNO board and
147+
then you need to launch QView, from the sub-directory `qview` in the
148+
`dpp_bsp-sam` example.
124149

125150

126151
----

0 commit comments

Comments
 (0)