Parameters

The Parameters element can be used to add read-write Signals that can be changed after deployment. These are typically used to configure the processing block. When writing a parameter object in run state (i.e. (Safe)Operational for SubDevices) the new parameter is immediately used by the processing block.

Example

Parameters:
  - Name: "Kfc"
    DataType: "Float"
    ResetValue: "0.0"
    Description: "Coulomb friction compensation gain."

  - Name: "MyBoolean"
    DataType: "Bool"
    ResetValue: "True"
    Description: "Boolean with reset value set to True."

  - Name: "MySwitchInput"
    DataType: "Uint8"
    ResetValue: "1"
    LowerBound: "0"
    UpperBound: "5"
    Description: "A uint8 which can be set to value 0-5 and has a default value of 1."

YAML schema

Schema for Parameters

Parameters: list(include('Signal'), required=False)

Schema for Signals

Signal:
  Name: name()
  DataType: Enum("Uint8", "Uint16", "Uint32", "Uint64", "Int8", "Int16", "Int32", "Int64", "Float", "Double", "Bool", required=True)
  Description: str(required=False)
  Unit: str(required=False)
  LowerBound: str(required=False)
  UpperBound: str(required=False)
  ResetValue: str(required=False)

Signal attributes

Attribute	Required	Description
Name	Yes	The name of the signal. Should comply with the Naming conventions.
DataType	Yes	The data type, supported types: “Uint8”, “Uint16”, “Uint32”, “Uint64”, “Int8”, “Int16”, “Int32”, “Int64”, “Float”, “Double”, “Bool”.
Description	No	The Description attribute of the signal.
Unit	No	The Unit attribute of the signal.
LowerBound	No	The LowerBound attribute of the signal. For Float and Double parameters the lower bound can be set to -Inf.
UpperBound	No	The UpperBound attribute of the signal. For Float and Double parameters the upper bound can be set to Inf.
ResetValue	No	The ResetValue attribute of the signal. The default reset value is 0. For Float and Double parameters the reset value can be set to NaN.