PyVCP

1. Einführung

PyVCP, Python Virtual Control Panel, wurde entwickelt, um dem Integrator die Möglichkeit zu geben, die AXIS-Schnittstelle mit Schaltflächen und Anzeigen für spezielle Aufgaben anzupassen.

Hardware-Maschinenbedienfelder können eine Menge E/A-Pins belegen und teuer sein. Hier haben virtuelle Control Panels den Vorteil, dass es nichts kostet, ein PyVCP zu erstellen.

Virtuelle Bedienfelder können zum Testen oder Überwachen verwendet werden, um reale E/A-Geräte beim Debuggen der Kontaktplanlogik vorübergehend zu ersetzen oder um ein physisches Bedienfeld zu simulieren, bevor Sie es bauen und mit einer E/A-Platine verbinden.

Die folgende Grafik zeigt viele der PyVCP-Widgets.

Figure 1. PyVCP Widgets Showcase

2. Panel Konstruktion

Das Layout eines PyVCP-Panels wird mit einer XML-Datei festgelegt, die Widget-Tags zwischen <pyvcp> und </pyvcp> enthält. Zum Beispiel:

<pyvcp>
    <label text="This is a LED indicator"/>
    <led/>
</pyvcp>

Figure 2. Einfaches PyVCP LED-Panel Beispiel

Wenn Sie diesen Text in eine Datei mit dem Namen tiny.xml einfügen und Folgendes ausführen

halcmd loadusr pyvcp -c mypanel tiny.xml

PyVCP will create the panel for you, which includes two widgets, a Label with the text This is a LED indicator, and a LED, used for displaying the state of a HAL BOOL signal. It will also create a HAL component named mypanel (all widgets in this panel are connected to pins that start with mypanel.). Since no <halpin> tag was present inside the <led> tag, PyVCP will automatically name the HAL pin for the LED widget mypanel.led.0

Für eine Liste der Widgets und ihrer Tags und Optionen, siehe nachfolgende Widget Übersicht.

Sobald Sie Ihr Panel erstellt haben, können Sie mit dem halcmd HAL-Signale mit den PyVCP-Pins verbinden:

net <signal-name> <pin-name> <opt-direction> <opt-pin-name>signal-name

Wenn Sie mit HAL noch nicht vertraut sind, ist das Kapitel HAL-Grundlagen im Integrator-Handbuch ein guter Ausgangspunkt.

3. Sicherheit

Teile von PyVCP-Dateien werden als Python-Code ausgewertet und können alle für Python-Programme verfügbaren Aktionen ausführen. Verwenden Sie nur PyVCP-XML-Dateien aus einer Quelle, der Sie vertrauen.

4. ACHSE

Since AXIS uses the same GUI toolkit (Tkinter) as PyVCP, it is possible to include a PyVCP panel at either the right side or the bottom of the AXIS user interface. It is not possible to display a panel in both of these positions simultaneously. A typical example is explained below.

Zusätzlich oder anstelle der Anzeige eines PyVCP-Panels wie oben beschrieben ist es möglich, ein oder mehrere PyVCP-Panels als eingebettete Registerkarten in der AXIS-GUI anzuzeigen. Dies wird durch den folgenden Eintrag im Abschnitt ‘[DISPLAY]’ der INI-Datei erreicht:

EMBED_TAB_NAME    = Spindle
EMBED_TAB_COMMAND = pyvcp spindle.xml

Die Textbeschriftung der Registerkarte AXIS zeigt "Spindel" an.

4.1. Beispiel-Panel

Legen Sie Ihre PyVCP-XML-Datei, die das Panel beschreibt, in demselben Verzeichnis ab, in dem sich Ihre INI-Datei befindet. Angenommen, wir möchten die aktuelle Spindeldrehzahl mit einem Balken-Widget anzeigen. Fügen Sie das Folgende in eine Datei namens spindle.xml ein:

<pyvcp>
    <label>
       <text>"Spindeldrehzahl:"</text>
    </label>
   <bar>
        <halpin>"spindle-speed"</halpin>
        <max_>5000</max_>
    </bar>
</pyvcp>

Hier haben wir ein Panel mit einem Label- und einem Balken-Widget erstellt, festgelegt, dass der HAL-Pin, der mit dem Balken verbunden ist, spindle-speed heißen soll, und den maximalen Wert des Balkens auf 5000 gesetzt (siehe Widget Übersicht unten für alle Optionen). Um AXIS auf diese Datei aufmerksam zu machen und sie beim Start aufzurufen, müssen wir in der [DISPLAY] Sektion der INI-Datei folgendes angeben:

PYVCP = spindle.xml

Wenn das Panel am unteren Rand der AXIS-Benutzeroberfläche erscheinen soll, müssen wir im Abschnitt [DISPLAY] der INI-Datei Folgendes angeben:

PYVCP_POSITION = BOTTOM

Alles andere als BOTTOM oder das Weglassen dieser Variable platziert das PyVCP-Panel auf der rechten Seite.

Damit unser Widget tatsächlich die Spindel-Geschwindigkeit anzeigt, muss es mit dem entsprechenden HAL-Signal verbunden werden. Eine HAL-Datei, die ausgeführt wird, sobald AXIS und PyVCP gestartet sind, kann im Abschnitt [HAL] der INI-Datei angegeben werden:

POSTGUI_HALFILE = spindle_to_pyvcp.hal

Diese Änderung führt die in spindle_to_pyvcp.hal angegebenen HAL-Befehle aus. In unserem Beispiel könnte der Inhalt wie folgt aussehen:

net spindle-rpm-filtered => pyvcp.spindle-speed

unter der Annahme, dass ein Signal namens spindle-rpm-filtered bereits existiert. Beachten Sie, dass in Verbindung mit AXIS alle PyVCP-Panel-Widget-HAL-Pins Namen haben, die mit pyvcp. beginnen, alle PyVCP-Embedded-Tab-Widget-HAL-Pins beginnen mit dem als EMBED_TAB_NAME angegebenen Namen, der in Kleinbuchstaben umgewandelt wurde.

So sollte das neu erstellte PyVCP-Panel in AXIS aussehen. Die Konfiguration "sim/lathe" ist bereits auf diese Weise konfiguriert.

5. Eigenständig (engl. stand alone)

Dieser Abschnitt beschreibt, wie PyVCP-Panels mit oder ohne LinuxCNCs Maschinensteuerung angezeigt werden können.

Um ein eigenständiges PyVCP-Panel mit LinuxCNC zu laden, verwenden Sie diese Befehle:

loadusr -Wn mypanel pyvcp -g WxH+X+Y -c mypanel <path/>panel_file.xml

Sie würden dies verwenden, wenn Sie ein schwebendes Bedienfeld oder ein Bedienfeld mit einer anderen GUI als AXIS wünschen.

-Wn panelname - veranlasst HAL zu warten, bis die Komponente panelname fertig geladen ist (in der HAL-Sprache bereit werden), bevor weitere HAL-Befehle verarbeitet werden. Dies ist wichtig, da PyVCP-Panels HAL-Pins exportieren und andere HAL-Komponenten diese benötigen, um sich mit ihnen zu verbinden. Beachten Sie das große W und das kleine n. Wenn Sie die Option -Wn verwenden, müssen Sie die Option -c verwenden, um das Panel zu benennen.
pyvcp < -g> < -c> panel.xml - erstellt das Panel mit der optionalen Geometrie und/oder dem Panel-Namen aus der Panel-XML-Datei. Die Datei panel.xml kann jeder Name sein, der auf .xml endet. Die XML-Datei ist die Datei, die beschreibt, wie das Panel zu erstellen ist. Sie müssen den Pfadnamen hinzufügen, wenn das Panel nicht in dem Verzeichnis liegt, in dem sich das HAL-Skript befindet.
-g <WxH><+X+Y> - gibt die Geometrie an, die bei der Konstruktion des Panels verwendet werden soll. Die Syntax lautet Breite x Höhe + X-Anker
Y-Anker. Sie können die Größe oder die Position oder beides festlegen. Der Ankerpunkt ist die obere linke Ecke des Panels. Ein Beispiel ist -g 250x500+800+0. Damit wird das Panel auf 250 Pixel Breite und 500 Pixel Höhe eingestellt und bei X800 Y0 verankert.
-c panelname - teilt PyVCP mit, wie die Komponente genannt werden soll und auch den Titel des Fensters. Der Panelname kann ein beliebiger Name ohne Leerzeichen sein.

Um ein eigenständiges PyVCP-Panel ohne LinuxCNC zu laden, verwenden Sie diesen Befehl:

loadusr -Wn mypanel pyvcp -g 250x500+800+0 -c mypanel mypanel.xml

Der minimale Befehl zum Laden eines PyVCP-Panels lautet:

loadusr pyvcp mypanel.xml

Sie würden diese verwenden, wenn Sie ein Panel ohne LinuxCNC’s Maschine Controller wie für die Prüfung oder ein Standalone-DRO wollen.

Der Befehl loadusr wird verwendet, wenn Sie auch eine Komponente laden, die HAL am Schließen hindert, bis sie fertig ist. Wenn Sie ein Panel laden und dann Classic Ladder mit loadusr -w classicladder laden, würde CL HAL (und das Panel) offen halten, bis Sie CL schließen. Das obige -Wn bedeutet, dass Sie warten, bis die Komponente -Wn "name" bereit ist. (name kann ein beliebiger Name sein. Beachte das große W und das kleine n.) Das -c weist PyVCP an, ein Panel mit dem Namen panel_file_name unter Verwendung der Informationen in panel_file_name.xml zu erstellen. Der Name panel_file_name.xml kann ein beliebiger Name sein, muss aber auf .xml enden - es ist die Datei, die beschreibt, wie das Panel zu erstellen ist. Sie müssen den Pfadnamen hinzufügen, wenn das Panel nicht in dem Verzeichnis liegt, in dem sich das HAL-Skript befindet.

Ein optionaler Befehl, den Sie verwenden können, wenn Sie möchten, dass das Panel HAL daran hindert, Befehle fortzusetzen / herunterzufahren. Nach dem Laden anderer Komponenten soll dies der letzte HAL-Befehl sein:

waitusr panelname

Hiermit wird HAL angewiesen, auf das Schließen der Komponente panelname zu warten, bevor HAL-Befehle fortgesetzt werden. Dies wird in der Regel als letzter Befehl eingestellt, so dass HAL heruntergefahren wird, wenn das Panel geschlossen ist.

6. Widgets

HAL signals come in two variants, bools and numbers. Bools are off/on signals. Numbers can be real, sint or uint. For more information on HAL data types see the HAL Data section. The PyVCP widget can either display the value of the signal with an indicator widget, or modify the signal value with a control widget. Thus there are four classes of PyVCP widgets that you can connect to a HAL signal. A fifth class of helper widgets allow you to organize and label your panel.

Widgets for indicating bool signals: led, rectled.
Widgets for controlling bool signals: button, checkbutton, radiobutton.
Widgets for indicating number signals: number, sint, uint, bar, meter.
Widgets zur Steuerung von numerischen Signalen: spinbox, scale, jogwheel.
Hilfs-Widgets: hbox, vbox, table, label, labelframe.

6.1. Syntax

Jedes Widget wird kurz beschrieben, gefolgt von dem verwendeten Markup und einem Screenshot. Alle Tags innerhalb des Haupt-Widget-Tags sind optional.

6.2. Allgemeine Anmerkungen

Gegenwärtig werden sowohl eine tag-basierte als auch eine attributbasierte Syntax unterstützt. So werden beispielsweise die folgenden XML-Fragmente identisch behandelt:

<led halpin="my-led"/>

und

<led><halpin>"my-led"</halpin></led>

Wenn die attributbasierte Syntax verwendet wird, werden die folgenden Regeln verwendet, um den Attributwert in einen Python-Wert zu verwandeln:

Wenn das erste Zeichen des Attributs eines der folgenden ist, wird es als Python-Ausdruck ausgewertet: {(["' .
Wird die Zeichenkette von int() akzeptiert, dann wird der Wert als Ganzzahl behandelt.
Bei Akzeptanz der Zeichenkette durch float() wird der Wert als Fließkommawert behandelt.
Andernfalls wird die Zeichenkette als Zeichenkette akzeptiert.

Bei Verwendung der Tag-basierten Syntax wird der Text innerhalb des Tags immer als Python-Ausdruck ausgewertet.

Die folgenden Beispiele zeigen eine Mischung aus verschiedenen Formaten.

Kommentare

Um einen Kommentar hinzuzufügen, verwenden Sie die XML-Syntax für einen Kommentar.

<!-- Mein Kommentar -->

Bearbeitung der XML-Datei

Bearbeiten Sie die XML-Datei mit einem Texteditor. In den meisten Fällen können Sie mit der rechten Maustaste auf die Datei klicken und "Mit Texteditor öffnen" oder ähnliches wählen.

Farben

Farben können unter Verwendung der X11-RGB-Farben mit dem Namen gray75 oder hex #0000ff angegeben werden. Eine vollständige Liste befindet sich auf https://sedition.com/perl/rgb.html.

Gebräuchliche Farben (Nummern bezeichnen Schattierungen der jeweiligen Farbe)

white (engl. für weiß)
black (engl. für schwarz)
blue (engl. für blau) und blue1 - 4
cyan und cyan1 - 4
green (engl. für grün) und green1 - 4
yellow (engl. für gelb) und yellow1 - 4
red (engl. für rot) und red1 - 4
purple (engl. für violett) und purple1 - 4
gray (amerikanisch für grau) und gray0 - 100

HAL-Pins

HAL-Pins bieten die Möglichkeit, das Widget mit etwas zu "verbinden". Sobald Sie einen HAL-Pin für Ihr Widget erstellt haben, können Sie ihn mit einem net-Befehl in einer .hal-Datei mit einem anderen HAL-Pin verbinden. Für weitere Informationen über den net-Befehl siehe den Abschnitt HAL Befehle.

6.3. Label

Ein Etikett ist eine Möglichkeit, Ihrem Panel Text hinzuzufügen.

<label></label> - erstellt ein Label.
<text>"text"</text> - der Text, der in das Etikett eingefügt werden soll; ein leeres Etikett kann als Abstandshalter verwendet werden, um andere Objekte auszurichten.
("Helvetica",20) - Schriftart und -größe des Textes angeben.
<relief>FLAT</relief> - Angabe des Rahmens um das Etikett (FLAT, RAISED, SUNKEN) Standard ist FLAT.
<bd>n</bd> - wobei n die Breite des Rahmens ist, wenn RAISED oder SUNKEN verwendet wird.
<padx>n</padx> - wobei n die Menge des zusätzlichen horizontalen Raums ist.
<pady>n</pady> - wobei n für die Anzahl der zusätzlichen vertikalen Leerzeichen steht.

Das Etikett hat einen optionalen Deaktivierungsstift, der erstellt wird, wenn Sie <disable_pin>True</disable_pin> hinzufügen.

<label>
    <text>"Dies ist ein Label:"</text>
    <font>("Helvetica",20)</font>
</label>

Der obige Code ergab dieses Beispiel:

Figure 3. Beispiel für ein einfaches Etikett

6.4. Multi_Label

Eine Erweiterung der Textbeschriftung.

Selectable text label, can display up to 6 label legends when associated bool pin is activated.

Verbinden Sie jeden Legenden-Pin mit einem Signal und erhalten Sie eine beschreibende Bezeichnung, wenn das Signal TRUE ist.

Wenn mehr als ein Legenden-Pin TRUE ist, wird die Legende mit der höchsten Nummer "TRUE" angezeigt.

Wenn ein Deaktivierungs-Pin mit <disable_pin>True</disable_pin> erstellt wird und dieser Pin auf true gesetzt wird, ändert sich die Beschriftung in einen ausgegrauten Zustand.

<multilabel>
    <legends>["Label1", "Label2", "Label3", "Label4", "Label5", "Label6"]</legends>
    <font>("Helvetica",20)</font>
    <disable_pin>True</disable_pin>
</multilabel>

Das obige Beispiel würde die folgenden Pins erzeugen.

pyvcp.multilabel.0.disable
pyvcp.multilabel.0.legend0
pyvcp.multilabel.0.legend1
pyvcp.multilabel.0.legend2
pyvcp.multilabel.0.legend3
pyvcp.multilabel.0.legend4
pyvcp.multilabel.0.legend5

Wenn Sie mehr als ein Multilabel haben, würden die erzeugten Pins die Nummer wie folgt erhöhen: pyvcp.multilabel.1.legend1.

6.5. LEDs

A LED is used to indicate the status of a bool halpin. The LED color will be on_color when the halpin is true, and off_color otherwise.

<led></led> - erzeugt eine runde LED
<rectled></rectled> - erzeugt eine rechteckige LED
<halpin>name</halpin> - Name des Pins, Standard ist led.n, wobei n eine ganze Zahl ist, die für jede LED inkrementiert wird.
<size>n</size> - n ist die Größe der LED in Pixeln, Standardwert ist 20.
<on_color>farbe</on_color>' - legt die Farbe der LED fest auf farbe, wenn der Pin wahr ist. Voreinstellung ist green (engl. für grün). Siehe Abschnitt zu Farben für weitere Informationen.
<off_color>farbe</off_color> - legt die Farbe der LED fest auf farbe, wenn der Pin falsch ist. Voreinstellung ist red (engl. für rot).
<height>n</height> - legt die Höhe der LED in Pixeln fest.
<width>n</width> - legt die Breite der LED in Pixeln fest.
<disable_pin>false</disable_pin> - bei true wird der LED ein Deaktivierungspin hinzugefügt.
<disabled_color>color</disabled_color> - setzt die Farbe der LED auf color, wenn der Pin deaktiviert ist.

Runde LED

<led>
    <halpin>"meine-LED"</halpin>
    <size>50</size>
    <on_color>"green"</on_color>
    <off_color>"red"</off_color>
</led>

Der obige Code ergab dieses Beispiel:

Figure 4. Beispiel für eine runde LED

Rechteckige LED

Dies ist eine Variante des "led" -Widgets.

<vbox>
    <relief>RIDGE</relief>
    <bd>6</bd>
    <rectled>
        <halpin>"meine-led"</halpin>
        <height>"50"</height>
        <width>"100"</width>
        <on_color>"green"</on_color>
        <off_color>"red"</off_color>
    </rectled>
</vbox>

Der obige Code erzeugt dieses Beispiel. Es zeigt auch einen vertikalen Kasten mit Relief.

Figure 5. Beispiel für eine einfache Rechteck-LED

6.6. Buttons

A button is used to control a BOOL pin. The pin will be set True when the button is pressed and held down, and will be set False when the button is released. Buttons can use the following optional options.

<padx>n</padx> - wobei n die Menge des zusätzlichen horizontalen Raums ist.
<pady>n</pady> - wobei n für die Anzahl der zusätzlichen vertikalen Leerzeichen steht.
<activebackground>"color"</activebackground> - der Cursor über Farbe auf color gesetzt.
<fg>"color"</fg> - die Vordergrundfarbe wird auf color gesetzt.
<bg>"color"</bg> - die auf color gesetzte Hintergrundfarbe.
<disable_pin>True</disable_pin> - Pin deaktivieren.

Text Button

A text button controls a bool halpin. The halpin is false until the button is pressed then it is true. The button is a momentary button.

Die Text Button hat einen optionalen Deaktivierungsstift, der beim Hinzufügen von <disable_pin>True</disable_pin> angelegt wird.

<button>
    <halpin>"ok-button"</halpin>
    <text>"OK"</text>
</button>
<button>
    <halpin>"abort-button"</halpin>
    <text>"Abort"</text>
</button>

Der obige Code ergab dieses Beispiel:

Figure 6. Beispiel für einfache Buttons

Checkbutton

A checkbutton controls a bool halpin. The halpin will be set True when the button is checked, and false when the button is unchecked. The checkbutton is a toggle type button. The checkbuttons may be set initially as TRUE or FALSE the initval field A pin called changepin is also created automatically, which can toggle the Checkbutton via HAL, if the value linked is changed, to update the display remotely.

Figure 7. Nicht-markierter (engl. unchecked) button

Figure 8. Markierter (engl. checked) Button

Checkbutton Code Beispiel

<checkbutton>
    <halpin>"coolant-chkbtn"</halpin>
    <text>"Coolant"</text>
    <initval>1</initval>
</checkbutton>
<checkbutton>
    <halpin>"chip-chkbtn"</halpin>
    <text>"Chips    "</text>
    <initval>0</initval>
</checkbutton>

Der obige Code ergab dieses Beispiel:

Figure 9. Einfaches Checkbutton-Beispiel

Das Kontrollkästchen für das Kühlmittel ist aktiviert.
Beachten Sie die zusätzlichen Leerzeichen im Text "Chips", um die Kontrollkästchen auszurichten.

Radiobutton

Ein Radiobutton setzt einen der HAL Pins auf true. Die anderen Pins werden auf false gesetzt. Das Feld initval kann eingestellt werden, um die Standardauswahl zu treffen, wenn das Panel angezeigt wird. Es darf nur ein Radiobutton auf TRUE (1) gesetzt werden, oder nur der Pin mit der höchsten Nummer, der auf TRUE gesetzt wurde, erhält diesen Wert.

<radiobutton>
    <choices>["one","two","three"]</choices>
    <halpin>"my-radio"</halpin>
    <initval>0</initval>
</radiobutton>

Der obige Code ergab dieses Beispiel:

Figure 10. Einfaches Radiobutton-Beispiel

Beachten Sie, dass die HAL-Pins im obigen Beispiel my-radio.one, my-radio.two und my-radio.three heißen werden. In der obigen Abbildung ist eins (engl. one) der ausgewählte Wert. Verwenden Sie das Tag "<orient>HORIZONTAL</orient>" für die horizontale Anzeige.

6.7. Nummernanzeigen

Für die Anzeige von Zahlen stehen folgende Formatierungsoptionen zur Verfügung

("Font Name",n) wobei n die Schriftgröße ist.
<width>_n_</width>, wobei n die Gesamtbreite des verwendeten Raums ist.
<justify>_pos_</justify>, wobei pos LEFT, CENTER oder RIGHT ist (funktioniert nicht).
<padx>__n__</padx>, wobei n die Menge des zusätzlichen horizontalen Raums ist.
<pady>__n__</pady>, - wobei n für die Anzahl der zusätzlichen vertikalen Leerzeichen steht.

Nummer

The number widget displays the value of a real signal.

<number>
    <halpin>"my-number"</halpin>
    <font>("Helvetica",24)</font>
    <format>"+4.4f"</format>
</number>

Der obige Code ergab dieses Beispiel:

Figure 11. Beispiel für einfache Zahlen

 - ist eine Tkinter-Schriftart und Größenangabe. Eine Schriftart, die mindestens bis zur Größe 200 angezeigt wird, ist "courier 10 pitch", so dass Sie für ein wirklich großes Zahlen-Widget angeben können:

<font>("courier 10 pitch",100)</font>

<format> - ist ein angegebenes Format im C-Stil, das bestimmt, wie die Zahl angezeigt wird.

sint Number

The sint number widget displays the value of a sint number. The syntax is the same as number except the name which is <sint>. Make sure the width is wide enough to cover the largest number you expect to use. This was formerly known as <s32>, which is now an alias for <sint>.

<sint>
    <halpin>"my-number"</halpin>
    <font>("Helvetica",24)</font>
    <format>"6d"</format>
    <width>6</width>
</sint>

Der obige Code ergab dieses Beispiel:

Figure 12. Simple sint Number Example

uint Number

The uint number widget displays the value of a uint number. The syntax is the same as number except the name which is <uint>. This was formerly known as <u32>, which is now an alias for <uint>.

Bar (engl. für Balken)

A bar widget displays the value of a real signal both graphically using a bar display and numerically. The color of the bar can be set as one color throughout its range (default using fillcolor) or set to change color, dependent upon the value of the halpin (range1, range2 range3 must all be set, if you only want 2 ranges, set 2 of them to the same color).

<halpin>"my-bar"</halpin> text, setzt den Pin-Namen: pyvcp.my-bar.
<min_>0</min_> Zahl, legt die minimale Skalierung fest.
<max_>140</max_> (Zahl), legt die maximale Skalierung fest.
<format>"3.1f"</format> (Text), setzt das Zahlenformat mit Python-Zahlenformatierung.
<bgcolor>"grau"</bgcolor> (Text), legt die Hintergrundfarbe fest.
<fillcolor>"rot"</fillcolor> (Text), setzt die Füllfarbe.
<range1>0,100, "grün"</range1> (Zahl, Zahl, Text), legt den ersten Bereich und die Farbe fest.
<range2>101,135, "orange"</range2> (number, number, text), legt den ersten Bereich und die Farbe fest.
<range3>136, 150, "rot"</range3> Zahl, Zahl, Text, legt den ersten Bereich und die Farbe fest.
<canvas_width>200</canvas_width>, (Zahl), legt die Gesamtbreite fest.
<canvas_height>50</canvas_height> (Zahl), legt die Gesamthöhe fest.
<bar_height>30</bar_height> (Zahl), legt die Balkenhöhe fest, muss kleiner sein als canvas_height.
<bar_width>150</bar_width> (Zahl), setzt die Balkenbreite, muss kleiner als canvas_width sein.

<bar>
    <halpin>"my-bar"</halpin>
    <min_>0</min_>
    <max_>123</max_>
    <format>"3.1f"</format>
    <bgcolor>"grey"</bgcolor>
    <fillcolor>"red"</fillcolor>
    <range1>0,100,"green"</range1>
    <range2>101,135,"orange"</range2>
    <range3>136, 150,"red"</range3>
    <canvas_width>200</canvas_width>
    <canvas_height>50</canvas_height>
    <bar_height>30</bar_height>
    <bar_width>150</bar_width>
</bar>

Der obige Code ergab dieses Beispiel:

Figure 13. Einfaches Bar-Beispiel

Meter

Meter displays the value of a real signal using a traditional dial indicator.

<meter>
    <halpin>"mymeter"</halpin>
    <text>"Battery"</text>
    <subtext>"Volts"</subtext>
    <size>250</size>
    <min_>0</min_>
    <max_>15.5</max_>
    <majorscale>1</majorscale>
    <minorscale>0.2</minorscale>
    <region1>(14.5,15.5,"yellow")</region1>
    <region2>(12,14.5,"green")</region2>
    <region3>(0,12,"red")</region3>
</meter>

Der obige Code ergab dieses Beispiel:

Figure 14. Einfaches Beispiel für ein Messgerät

6.8. Numerische Eingaben

Spinbox (Einstellrad)

A spinbox controls a real pin. You increase or decrease the value of the pin by either pressing on the arrows, or pointing at the spinbox and rolling your mouse-wheel. If the param_pin field is set TRUE(1), a pin will be created that can be used to set the spinbox to an initial value and to remotely alter its value without HID input.

<spinbox>
    <halpin>"my-spinbox"</halpin>
    <min_>-12</min_>
    <max_>33</max_>
    <initval>0</initval>
    <resolution>0.1</resolution>
    <format>"2.3f"</format>
    <font>("Arial",30)</font>
    <param_pin>1</param_pin>
</spinbox>

Der obige Code ergab dieses Beispiel:

Figure 15. Einfaches Spinbox-Beispiel

Skala

A scale controls a real or a sint pin. You increase or decrease the value of the pin be either dragging the slider, or pointing at the scale and rolling your mouse-wheel. The halpin will have both -f and -i added to it to form the real and sint pins. Width is the width of the slider in vertical and the height of the slider in horizontal orientation. If the param_pin field is set TRUE(1), a pin will be created that can be used to set the spinbox to an initial value and to remotely alter its value without HID input.

<scale>
    <font>("Helvetica",16)</font>
    <width>"25"</width>
    <halpin>"my-hscale"</halpin>
    <resolution>0.1</resolution>
    <orient>HORIZONTAL</orient>
    <initval>-15</initval>
    <min_>-33</min_>
    <max_>26</max_>
    <param_pin>1</param_pin>
</scale>
<scale>
    <font>("Helvetica",16)</font>
    <width>"50"</width>
    <halpin>"my-vscale"</halpin>
    <resolution>1</resolution>
    <orient>VERTICAL</orient>
    <min_>100</min_>
    <max_>0</max_>
    <param_pin>1</param_pin>
</scale>

Der obige Code ergab dieses Beispiel:

Figure 16. Beispiel für eine einfache Skalierung

Note	Beachten Sie, dass standardmäßig "min" angezeigt wird, auch wenn es größer als "max" ist, es sei denn, "min" ist negativ.

Wählscheibe (engl. dial)

The Dial outputs a HAL real and reacts to both mouse wheel and dragging. Double left click to increase the resolution and double right click to reduce the resolution by one digit. The output is capped by the min and max values. The <cpr> is how many tick marks are on the outside of the ring (beware of high numbers). If the param_pin field is set TRUE(1), a pin will be created that can be used to set the spinbox to an initial value and to remotely alter its value without HID input.

<dial>
    <size>200</size>
    <cpr>100</cpr>
    <min_>-15</min_>
    <max_>15</max_>
    <text>"Dial"</text>
    <initval>0</initval>
    <resolution>0.001</resolution>
    <halpin>"anaout"</halpin>
    <dialcolor>"yellow"</dialcolor>
    <edgecolor>"green"</edgecolor>
    <dotcolor>"black"</dotcolor>
    <param_pin>1</param_pin>
</dial>

Der obige Code ergab dieses Beispiel:

Figure 17. Einfaches Wählbeispiel

Jogwheel

Jogwheel mimics a real jogwheel by outputting a real pin which counts up or down as the wheel is turned, either by dragging in a circular motion, or by rolling the mouse-wheel.

Optionale Tags:

<text>"Mein Text"</text> zeigt Text an
<bgcolor>"grey"</bgcolor> <fillcolor>"green"</fillcolor> Hintergrund- und aktive Farben
<scale_pin>1</scale_pin> creates scale text and a REAL.scale pin to display jog scale
<clear_pin>1</clear_pin> creates DRO and a BOOL.reset pin to reset DRO. Needs scale_pin for scaled DRO. Shift+click resets DRO also

<jogwheel>
    <halpin>"my-wheel"</halpin>
    <cpr>45</cpr>
    <size>250</size>
</jogwheel>

Der obige Code ergab dieses Beispiel:

Figure 18. Einfaches Jogwheel-Beispiel

6.9. Bilder

Die Bilder dürfen nur im .gif-Format angezeigt werden. Alle Bilder müssen die gleiche Größe haben. Die Bilder müssen sich im gleichen Verzeichnis wie Ihre INI-Datei befinden (oder im aktuellen Verzeichnis, wenn Sie das Programm von der Kommandozeile aus mit halrun/halcmd ausführen).

Image Bit

The image_bool toggles between two images by setting the halpin to true or false. This was formerly known as image_bit, which is now an alias for image_bool.

<image name='fwd' file='fwd.gif'/>
<image name='rev' file='rev.gif'/>
<vbox>
    <image_bool halpin='selectimage' images='fwd rev'/>
</vbox>

Dieses Beispiel wurde mit dem obigen Code erstellt. Es verwendet die beiden Bilddateien fwd.gif und rev.gif. FWD wird angezeigt, wenn "selectimage" falsch ist, und REV wird angezeigt, wenn "selectimage" wahr ist.

Figure 19. Selectimage False Beispiel

Figure 20. Selectimage True Beispiel

Image uint

The image_uint is the same as image_bool, except you have essentially an unlimited number of images and you select the image by setting the halpin to a integer value with 0 for the first image in the images list and 1 for the second image, etc. This was formerly known as image_u32, which is now an alias for image_uint.

<image name='stb' file='stb.gif'/>
<image name='fwd' file='fwd.gif'/>
<image name='rev' file='rev.gif'/>
<vbox>
    <image_uint halpin='selectimage' images='stb fwd rev'/>
</vbox>

Der obige Code erzeugt das folgende Beispiel, indem das Bild stb.gif hinzugefügt wird.

Figure 21. Simple image_uint Example with halpin=0

Figure 22. Simple image_uint Example withhalpin=1

Figure 23. Simple image_uint Example withhalpin=2

Beachten Sie, dass der Standardwert der Minimalwert ist, auch wenn er höher als der Maximalwert ist, es sei denn, es gibt einen negativen Minimalwert.

6.10. Containers (engl. für Behälter)

Container sind Widgets, die andere Widgets enthalten. Container werden verwendet, um andere Widgets zu gruppieren.

Begrenzungen (engl. borders)

Containerränder werden mit zwei Tags angegeben, die zusammen verwendet werden. Der <relief>-Tag gibt die Art des Rahmens an, und der <bd>-Tag gibt die Breite des Rahmens an.

<relief>_Typ_</relief>: Wobei Typ FLAT, SUNKEN, RAISED, GROOVE, oder RIDGE ist.
<bd>_n_</bd>: Dabei ist n die Breite des Rahmens.

<hbox>
    <button>
        <relief>FLAT</relief>
        <text>"FLAT"</text>
        <bd>3</bd>
    </button>
    <button>
        <relief>SUNKEN</relief>
        <text>"SUNKEN"</text>
        <bd>3</bd>
    </button>
    <button>
        <relief>RAISED</relief>
        <text>"RAISED"</text>
        <bd>3</bd>
    </button>
    <button>
        <relief>GROOVE</relief>
        <text>"GROOVE"</text>
        <bd>3</bd>
    </button>
    <button>
        <relief>RIDGE</relief>
        <text>"RIDGE"</text>
        <bd>3</bd>
    </button>
</hbox>

Der obige Code ergab dieses Beispiel:

Figure 24. Container Borders Showcase

Ausfüllen (engl. fill)

Containerfüllungen werden mit dem Tag <boxfill fill=""/> angegeben. Gültige Einträge sind none, x, y und both. Die x-Füllung ist eine horizontale Füllung und die y-Füllung ist eine vertikale Füllung

<boxfill fill ="style"/>: Dabei ist style none, x, y oder beides. Standardwert ist x für Vbox und y für Hbox.

Anker

Container-Anker werden mit dem Tag <boxanchor anchor=""/> angegeben. Der Anker gibt an, wo jeder Slave in seiner Parzelle positioniert werden soll. Gültige Einträge sind center, n, s, e, w, für center, north, south, east und west. Kombinationen wie sw, se, nw und ne sind ebenfalls gültig.

<boxanchor anchor="position"/>: Dabei ist Position center, n, s, e, w, ne, nw, se oder sw. Standardwert ist Mitte.

Erweitern

Container expand wird mit dem booleschen Tag <boxexpand expand=""/> angegeben. Gültige Einträge sind "yes", "no".

<boxexpand expand="boolean"/>: Wobei boolean entweder "yes" (engl. für ja) oder "no" (nein) ist. Die Voreinstellung ist "yes".

Hbox

Verwenden Sie eine Hbox, wenn Sie Widgets horizontal nebeneinander stapeln möchten.

<hbox>
    <relief>RIDGE</relief>
    <bd>6</bd>
    <label><text>"a hbox:"</text></label>
    <led></led>
    <number></number>
    <bar></bar>
</hbox>

Der obige Code ergab dieses Beispiel:

Figure 25. Einfaches hbox-Beispiel

Innerhalb einer Hbox können Sie die Tags <boxfill fill=""/>, <boxanchor anchor=""/> und <boxexpand expand=""/> verwenden, um festzulegen, wie sich die Elemente in der Box verhalten, wenn die Größe des Fensters geändert wird.Die Standardeinstellung ist fill="y", anchor="center", expand="yes" für eine Hbox.

Vbox

Verwenden Sie eine Vbox, wenn Sie Widgets vertikal übereinander stapeln möchten.

<vbox>
    <relief>RIDGE</relief>
    <bd>6</bd>
    <label><text>"eine vbox:"</text></label>
    <led></led>
    <number></number>
    <bar></bar>
</vbox>

Der obige Code ergab dieses Beispiel:

Figure 26. Einfaches vbox-Beispiel

Innerhalb einer Vbox können Sie die Tags <boxfill fill=""/>, <boxanchor anchor=""/>, jnd <boxexpand expand=""/> verwenden, um festzulegen, wie sich die Elemente in der Box verhalten, wenn die Größe des Fensters geändert wird. Die Standardeinstellung ist fill="x", anchor="center", expand="yes" für eine Vbox.

Etikettrahmen (engl. labelframe)

Ein Etikettenrahmen (engl. labelframe) ist ein Rahmen mit einer Rille und einem Etikett in der oberen linken Ecke.

<labelframe text="Label: Leds groupées">

<labelframe text="Group Title">
    <font>("Helvetica",16)</font>
    <hbox>
    <led/>
    <led/>
    </hbox>
</labelframe>

Der obige Code ergab dieses Beispiel:

Figure 27. Einfaches Labelframe-Beispiel

Tabelle (engl. table)

Eine Tabelle (engl. table) ist ein Container, der das Layout in einem Raster aus Zeilen und Spalten ermöglicht. Jede Zeile wird mit einem "<tablerow/>"-Tag eingeleitet. Ein enthaltenes Widget kann sich über Zeilen oder Spalten erstrecken, indem es das Tag "<tablespan rows= cols=/>" verwendet. Die Seiten der Zellen, an denen die enthaltenen Widgets "kleben", können durch die Verwendung des Tags "<tablesticky sticky=/>" festgelegt werden. Eine Tabelle dehnt sich über ihre flexiblen Zeilen und Spalten aus.

Tabelle Code Beispiel

<table flexible_rows="[2]" flexible_columns="[1,4]">
<tablesticky sticky="new"/>
<tablerow/>
    <label>
        <text>" A (cell 1,1) "</text>
        <relief>RIDGE</relief>
        <bd>3</bd>
    </label>
    <label text="B (cell 1,2)"/>
    <tablespan columns="2"/>
    <label text="C, D (cells 1,3 and 1,4)"/>
<tablerow/>
    <label text="E (cell 2,1)"/>
    <tablesticky sticky="nsew"/>
    <tablespan rows="2"/>
    <label text="'spans\n2 rows'"/>
    <tablesticky sticky="new"/>
    <label text="G (cell 2,3)"/>
    <label text="H (cell 2,4)"/>
<tablerow/>
    <label text="J (cell 3,1)"/>
    <label text="K (cell 3,2)"/>
    <uint halpin="test"/>
</table>

Der obige Code ergab dieses Beispiel:

Figure 28. Beispiel für eine Tabelle

Registerkarten (engl. tabs)

Eine Benutzeroberfläche mit Registerkarten kann ziemlich viel Platz sparen.

<tabs>
    <names> ["spindle","green eggs"]</names>
</tabs>
<tabs>
    <names>["Spindle", "Green Eggs", "Ham"]</names>
    <vbox>
        <label>
            <text>"Spindle speed:"</text>
        </label>
        <bar>
            <halpin>"spindle-speed"</halpin>
            <max_>5000</max_>
        </bar>
    </vbox>
    <vbox>
        <label>
            <text>"(this is the green eggs tab)"</text>
        </label>
    </vbox>
    <vbox>
        <label>
            <text>"(this tab has nothing on it)"</text>
        </label>
    </vbox>
</tabs>

Der obige Code ergibt dieses Beispiel, in dem jede ausgewählte Registerkarte angezeigt wird.

Figure 29. Einfache Tabs-Beispiel