Skip to content

docs: add standalone pyvcp testing example #4312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
grandixximo wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −0
Open

docs: add standalone pyvcp testing example #4312

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/src/gui/pyvcp-examples.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,33 @@
= PyVCP Examples


== Testing a Panel Without HAL

A PyVCP panel can be opened directly with the `pyvcp` command to check the
layout and widgets before connecting it to HAL.
Put the following in a file named `hello_world.xml`:

[source,xml]
----
<pyvcp>
<vbox>
<label>
<text>"Hello CNC"</text>
</label>
</vbox>
</pyvcp>
----

Then run the command from a terminal:

[source,shell]
----
pyvcp hello_world.xml
----

This opens the panel as a standalone window.
It makes the edit/test cycle fast because no HAL setup is required.

== AXIS

To create a PyVCP panel to use with the AXIS interface that is
Expand Down
Loading