User Tools

Site Tools


parameter

Parameter

Many commands sent to a device need parameter(s) to make sense. E.g. a CueUp command for a DVD Player need a framecode to tell the DVD player where to go. Also a CueUPChapter command need the chapter number as parameter to specify which chapter is meant. An example for a parameter less command is the Play command. This instruction contains all the information that is needed for the driver, simply turn the device in play mode. As these examples show, it is necessary to refer parameters to a command.

In V-Control, up to six parameters for each command are available. We distinguish between device parameters (DP1 and DP2) and command parameters (P1 - P4). Both parameter types are equivalent and used in the same way. Device parameters concerning more the device itself. For example, some projectors can daisy chain the serial signal so that many projectors can use the same serial port. In this case all projectors in that chain get the same serial commands, so each projector need a unique address. This address is, from V-Control 's point of view, a parameter. Because this parameter concerns the device and not the command, we use it as device parameter. If an InputSelect command is sent to one of those projectors in the chain, two parameters are needed, one that addresses the device, and one that say the addressed device which input should be selected.

To enter a parameter, an parameter input field is needed. This could be a text field, a spin button or a drop down box. In the example above a spin button is used to enter the projector address, and a drop down box select the desired input.The parameter input field is defined by five controls in the device editor.

1. Name: The name of the parameter. This is just a label that tells the user what kind of parameter is needed.

2. GUI: The type of the input field. Three types are available.

  • Spin Button: A field for numeric values
  • Drop Down Box: A list of predefined values
  • Textfeld: An input field for all kind of parameters

3. MinMax:

  • If the GUI type is spin button, then this field contains the minimum and maximum value, separated by a semicolon. In the example above the parameter Address can have any value between 0 and 64. Other values are not accepted.
  • If the GUI type is drop down box, then this field contain a semicolon separated list of all possible values. E.G. if the projector has a RGB, a Video and a S-Video input, the content of this field could be “RGB;VIDEO;S-VIDEO”.
  • If the GUI type is text field, then this field is inactive.

4. Default:

  • If the GUI type is spin button, then this field optionally contains the default numeric value that is used for the parameter. The default value must be in the range defined with the MinMax value.
  • If the GUI type is drop down box, this field contains the list item selected by default. The value MUST be one of the semicolon separated values defined in the MinMax field.
  • If the GUI type is text field, then this field contains the default value for the text field.

5. Mask:

  • Inactive if GUI type is spin button
  • Inactive if GUI type is drop down box
  • If the GUI type is text field, an optional mask for the field is defined here.
Mask Character Description
#Any single digit placeholder. The user can type only a digit character in this position.
.Decimal placeholder. The decimal placeholder that is actually used is specified in the user's International settings. The character is treated as a literal (formatting) character for masking purposes.
,Thousands separator. The thousands separator that is actually used is specified in the user's International settings. The character is treated as a literal (formatting) character for masking purposes.
:Time separator. The time separator that is actually used is specified in the user's International settings. The character is treated as a literal (formatting) character for masking purposes.
/Date separator. The date separator that is actually used is specified in the user's International settings. The character is treated as a literal (formatting) character for masking purposes.
\Mask escape character. Treat the next character in the mask as a literal. The escape character enables you to use the '#', '&', 'A', '?' (an so on) characters in the mask. The escapted character is treated as a literal (formatting) character.
&Character placeholder. Valid values are the ASCII characters 32-126 and the non-ASCII characters 128-255.
>Convert all the characters that follow to uppercase. Uppercasing works beyond the ASCII range where appropriate, e.g., ü becomes Ü.
<Convert all the characters that follow to lowercase. Lowercasing works beyond the ASCII range where appropriate, e.g., Ü becomes ü.
AAlphanumeric character placeholder, where entry is mandatory. For example, the spec “AAA” specifies three alphabetic characters.
aAlphanumeric character placeholder, where entry is optional.
9Digit placeholder where entry is optional.
CCharacter or space placeholder, where entry is optional. It operates like the '&' placeholder.
?Alphabetic placeholder.
Any literal All other symbols are displayed as literals for formatting purposes.
~Reserved for future use. If you use “~” it will trigger an exception error. Use \~ instead.
parameter.txt · Last modified: 2013/08/19 09:41 by admin