Parameters

A parameter is a term used to describe a section or sections of a command that are user editable within the Builder. Within this thread we will discuss how to build parameters within the Device Driver Editor.

Note Parameters include, but are not limited to, Zones, Outputs, and ID’s (Lights, Displays, etc.). In general creating a parameter within the Device Driver Editor reduces the amount of command strings and assists the programmer in identifying a common name for the above options.

Constraints/Defaults

Possible Values

This section identifies the user facing name of the command and the device encoded value of the command.

• Parameter Name
  • This value represents what the programmer will see within the builder upon dragging a command to a widget
• Parameter Type
  • String
    • This is a literal string of text. Tech Tip Examples are HDMI or Input
  • Number
    • This is a numerical value
  • Boolean
    • This is a two option statement. Tech Tip Examples are 0/1, True/False, or On/Off
• Parameter is Dynamic
  • This option determines if the parameter requires a widget when added to the User Interface. Tech Tip Discrete volume commands would be Dynamic and use a slider within the User Interface and Strings would add a list box.
• Constraints and Defaults
  • Each parameter type has a different set of Constraints and Defaults
    • String
      • Possible Values
        • Actual Value is what the user can see within the Builder
        • Device Encoded Value is the value sent to and received from the device
      • Number
        • Minimum value is the lowest possible accepted value
        • Maximum value is the highest possible accepted value
        • Step value is the precision of the number. Note Example a step value of 1 would adjust the device from the previous value of 1 to a new value of 2.
    • Show decimal point is used when the device displays a decimal point value
    • Number of characters is how many characters that are expected to represent this parameter by the protocol. Extra leading characters will be omitted during transmission and 0’s will be prepended to meet this length if necessary. 0 means use exactly the number of characters required without omitting or padding.
  • Boolean
    • If your device follows one of these conventions ( 0/1, On/Off, True/False) you do not need a possible value
    • If your device does not follow one of the above conventions you will need to create possible values for On and Off

• Adding an attribute to a parameter allows the programmer to alter the user facing name within the client. Tech Tip One example would be Output 1 = Top Left Display, Output 2 = Top Right Diplay, Output 3 = Lower Left Display and Output 4 = Lower Right Display
• Initialized in Builder
  • Allows the user to change the parameter value that is displayed within the builder
• Other options
  • The other options of Alias Heading, Actual Value Heading and Instructions provide the programmer notes for the possible value to be entered within the builder