Documentation Portal / FrontPanel SDK / FrontPanel Application / XML Components / okDigitEntry (Wire In)
FrontPanel SDK

okDigitEntry (Wire In)

This component allows a more flexible way to convey numerical information to your design.  The okDigitEntry attaches to one or more Wire In endpoints and allows the user to enter a numerical value using the mouse and/or keyboard.  The bounds on the value are set in the component properties.

The okDigitEntry component is designed to allow fast entry through either the mouse or keyboard.  Using the mouse, you can hover over any digit and change its value using the scrollwheel.  Likewise, by pressing a number on the keyboard when a digit is highlighted, that particular digit is changed and the highlight moves to the next digit on the right.

ELEMENTTYPEDESCRIPTION
positionPOSITIONPosition of the top left corner.
sizeSIZESize in pixels.
tooltipTEXTTooltip text.
endpointHEX BYTEEndpoint address for the corresponding Wire In.  The entry will span multiple consecutive endpoints as necessary.
bitNUMBERThis bit on the endpoint is the LSB for the entry.
minvalueNUMBERThe minimum allowed value in the entry.
maxvalueBIGNUMBERThe maximum allowed value in the entry.
prescaleFLOATA floating point value between 0.5 and 2.0. The value of the okDigitEntry is multiplied by the prescale factor before being sent to the device. Any scaling beyond multiples of 2 can be handled by bit shifts in the FPGA logic.Note: Requires FrontPanel version 5.0.2 or later.
radixNUMBERNumerical radix of the entry (2, 8, 10 [default], or 16). Note that this element is incompatible with the decimalpointlocation element.
decimalpointlocationNUMBERIndicates that the component accepts floating-point values with the specified number of digits after the decimal point. Without this element, the component allows the entry of integer values only. Note that this element is incompatible with the radix element.
valueNUMBERThe default value for the entry.

XML Example

<object class="okDigitEntry">
	<position>5,215</position>
	<size>200,30</size>
	<tooltip>Sets the integer divider.</tooltip>
	<minvalue>0</minvalue>
	<maxvalue>16777215</maxvalue>
	<value>49837</value>
	<endpoint>0x07</endpoint>
	<bit>0</bit>
</object>Code language: HTML, XML (xml)

Lua Scripting

This component supports executing a script function when its value changes and changing its value using its SetValue(), for integer, or SetFloatValue(), for floating-point, input.

Integer-valued version has the following component-specific methods:

  • SetValue(value) and GetValue() access the current value.
  • SetRadix(radix) and GetRadix() can be used to change or retrieve the radix used by the component.
  • SetLowerLimit(limit), SetUpperLimit(limit) and the corresponding getters GetLowerLimit(), GetUpperLimit() change or retrieve the bounds used for the component value.

For the floating-point components the following methods are available:

  • SetFloatValue(value) and GetFloatValue() access the current value.
  • SetDecimalPointLocation(n) and GetDecimalPointLocation() set or return the location of the decimal point in the component.
  • SetFloatLowerLimit(limit), SetFloatUpperLimit(limit), GetFloatLowerLimit() and GetFloatUpperLimit() change or retrieve the bounds used for the component value.

See also FindDigitEntry() method of the panel object.

All XML components that support Lua scripting also inherit from the Control class. Please refer to the FrontPanel Scripting documentation for more information on this class.

Example Screenshot