HAL Widgets

These widgets generate HAL pins by which they can control or be controlled by external HAL signals. HAL signals must be connected in the POSTGUI_HALFILE since they do not exist until the GUI has been fully loaded.

All pins belong to the qtpyvcp HAL component. Pin names are derived from the widget’s ObjectName as set in designer, with any underscores replaced by dashes.

class qtpyvcp.widgets.hal_widgets.hal_button.HalButton(parent=None)

HAL Button

Button for setting bit HAL pin values.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.button.enable	bit	in
qtpyvcp.button.out	bit	out
qtpyvcp.button.check	bit	in
qtpyvcp.button.checked	bit	out
qtpyvcp.button.io	bit	io

Note

The qtpyvcp.button.check and qtpyvcp.button.checked halpins are only present if the checkable property is set to true. check sets the checked state from HAL, and checked reports it.

flashOnChecked = <PySide6.QtCore.Property object>

pulseOnPress = <PySide6.QtCore.Property object>

pulseDuration = <PySide6.QtCore.Property object>

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_plot.HalPlot(parent=None)

HAL Plot

Plots HAL pin values over time, similar to HAL scope. Up to four HAL pin values can be plotted.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.<pinBaseName>.<series1name>	float	in
qtpyvcp.<pinBaseName>.<series2name>	float	in
qtpyvcp.<pinBaseName>.<series3name>	float	in
qtpyvcp.<pinBaseName>.<series4name>	float	in

A pin is only created for a series that is enabled. Series 1 is on by default, series 2 to 4 are off. Spaces are removed from the series name, so the default name Series 1 gives a pin ending in Series1.

pinBaseName defaults to the widget’s objectName, with _ changed to -. For example, a plot named halplot with series 1 left at its default name has the pin qtpyvcp.halplot.Series1.

pinBaseName, series1name to series4name and series1enable to series4enable are set in the Qt Designer property editor.

class qtpyvcp.widgets.hal_widgets.hal_spinbox.HalQSpinBox(parent=None)

HAL SpinBox

SpinBox for displaying and setting u32 and s32 HAL pin values.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.spinbox.enable	s32 | u32	in
qtpyvcp.spinbox.in	s32 | u32	in
qtpyvcp.spinbox.out	s32 | u32	out

Note

If the minimum value property is set to 0 or greater a u32 HAL pin will be created, if the minumum value is less than 0 then a s32 HAL pin will be created.

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_groupbox.HalGroupBox(parent=None)

HAL GroupBox

GroupBox that can be enabled/disabled via HAL pins.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.group-box.enable	bit	in
qtpyvcp.group-box.visible	bit	in
qtpyvcp.group-box.check	bit	in
qtpyvcp.group-box.checked	bit	out

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_slider.HalSlider(parent=None)

HAL Slider

Slider for setting u32 or float HAL pin values.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.slider.enable	bit	in
qtpyvcp.slider.out-i	u32	out
qtpyvcp.slider.out-f	float	out

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_checkbox.HalCheckBox(parent=None)

HAL CheckBox

CheckBox for displaying and setting bit HAL pin values.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.checkbox.enable	bit	in
qtpyvcp.checkbox.check	bit	in
qtpyvcp.checkbox.checked	bit	out

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_lcd.HalLCDNumber(parent=None)

HAL LCD Number

LCD Number for displaying float or s32 HAL pin values.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.lcd.in-i	s32	in
qtpyvcp.lcd.in-f	float	in

numberFormat = <PySide6.QtCore.Property object>

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_double_spinbox.HalDoubleSpinBox(parent=None)

HAL DoubleSpinBox

DoubleSpinBox for displaying and setting float HAL pin values.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.spinbox.enable	bit	in
qtpyvcp.spinbox.in	float	in
qtpyvcp.spinbox.out	float	out

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_led.HalLedIndicator(parent=None)

HAL LED

LED for indicated the state of bit HAL pins.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.led.on	bit	in
qtpyvcp.led.flash	bit	in
qtpyvcp.led.flash-rate	u32	out

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_led_button.HALLEDButton(parent=None)

HAL Led Button

Button for displaying HAL pin values.

flashPinName = <PySide6.QtCore.Property object>

pinName = <PySide6.QtCore.Property object>

class qtpyvcp.widgets.hal_widgets.hal_label.HalLabel(parent=None)

HAL Label

Label for displaying HAL pin values.

Input pin type is selectable via the pinType property in designer, and can be any valid HAL type (bit, u32, s32, float).

The text format can be specified via the valueFormat property in designer and can be any valid python style format string.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.label.enable	bit	in
qtpyvcp.label.in	selecatable	in

valueFormat = <PySide6.QtCore.Property object>

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.hal_widgets.hal_bar_indicator.HalBarIndicator(parent=None)

HAL Bar Indicator

Bar for indicating the value of float HAL pins.

Generated HAL Pins

HAL Pin Name	Type	Direction
qtpyvcp.bar-indicator.in-i	u32	in
qtpyvcp.bar-indicator.in-f	float	in
qtpyvcp.bar-indicator.min-val	float	in
qtpyvcp.bar-indicator.max-val	float	in

initialize()

This method is called right before the main application starts.