FillParamTable.Config.json

FillParamTable.Config.json defines the details of the individual entries in the generated table. A standard file is used within the package. As soon as a Config.json file is passed to the FillParamTable function, the passed file and the internal file are merged. If entries exist in both files, the entry in the transferred file is prioritized.

The basic schema of the file is structured as follows:

{
    "$schema": "./TwinCAT.HMI.Plastic.Functions/Schema/FillParamTable.Config.Schema.json",
    "UnitMappings": {
        "Default": {…},
        "Trafo": {…},
        "UnitGroup": {…},
        "Fixed": {…},
        "…": {…}
    },
    "Localizations": {…},
    "ParamInfo": {
        "Default": {…},
        "…": {…}
    },
    "ReadOnly": {
        "Map": {…},
        "Conditions": {…},
    },
    "Enums": {
        "…": [{
            "id": 0,
            "text": "…",
            "value": "…"
        },…],…
    },
    "Filters": {
        "Default": […],
        "AxisUnitGroups": […],
        "ElectricalUnitGroups": […],
        "InverterExcludes": […],
        "HydraulicExclusive": […]
    },
    "AccessRights": {
        "…": [{
            "accesright": "…",
            "group": "…",
            "permission": "…"
        },…],…
    },
    "configVersion": "1.0.0.0"
}

Element	Description	Optional
`$schema`	References the schema file that enables code editors to support editing of the file.	Yes
`UnitMappings`	Enables the assignment of units per table entry found. Detailed information about the schema is explained further below.	Yes
`Localizations`	Redirects the name of a PLC element to a different LocalizationKey. Example: `"LimitH": "LimitHigh"`	Yes
`ParamInfo`	Redirects the description information of a table entry to a different key. Standardized redirections can be defined under `Default`, all other elements are synchronized with the PLC instances.	Yes
`ReadOnly`	Defines table entries that can be written to the PLC but should not be modified by the table. It is also possible to implement a conditional switchover of an entry via `Conditions`. Detailed information about the schema is explained further below.	Yes
`Enums`	Defines enumerations for use with a combo box instead of a numeric input field. The elements to be passed as an array must be formatted according to the TcHmi.Controls.Combobox.ListItem schema.	Yes
`Filters`	Defines, for the listed entries, a list of table entries that should be ignored or filtered under certain circumstances. Elements that are always ignored can be stored under `Default`.	Yes
`AccessRights`	Defines specific user management access rights for an entry. The elements to be transferred as an array must be formatted according to the TcHmi.AccesControl schema.	Yes
`configVersion`	Defines the version of the schema used. This entry is required in order to convert future changes to the schema.	No

All listings require the name of the PLC element to be specified for referencing. For example values, refer to the schema description of UnitMappings.

UnitMappings

The UnitMappings schema offers various groupings of the assignment:

"UnitMappings": {
   "Default": {
      "SoftEndMin": "Length",…
   },
   "Trafo": {
      "DriveSoftEndMin": "::fbSpecific::fbTrafo::DriveUnitGroup",…
   },        
   "UnitGroup": {
      "MaxVeloApplication": "::UnitGroup~Velocity",…
   },
   "Fixed": {
      "TorqueLimitingCapacity": "Unit_Torque_Newton_Meter",…
   },
   "AnalogValue": {
      "ScalingElectricalMin": "::UnitGroupElectrical",…
   }
}

Element	Description
Default	These default assignments are used if no special elements are defined.
Trafo	Specific assignments for transformation axes that are used primarily.
UnitGroup	If the transferred PLC element contains a property named `UnitGroup`, symbol-related dependencies can be defined in this element.
Fixed	For entries that are not to be switchable, fixed units (system unit = display unit) can be defined in this element.
AnalogValue (Custom)	Additional keys (here, for example, `AnalogValue` for a PLC instance `fbParamAnalogValue`) can be defined for group-related special handling.

ReadOnly

Entries with read-only access can be set via ReadOnly. There are also conditional options that can be switched during runtime.

"Map": {
   "TuningLastExecution": "true",
   "CreepDistanceM": "AsymTargeting",…
},
"Conditions": {
   "AsymTargeting": {
       "Symbol": true,
       "Inverted": true,
       "CreateLatch": false,
       "Latch": "ValueToCheck"
   },…
}

Element		Description
`Map`		Describes a list of elements that should always, never, or conditionally receive read access. The following definitions are possible: `true` – for permanently restricting write access `false` – for permanently enabling write access `Custom` - a user-specific condition to be listed under `Conditions`
`Conditions`		Configuration of conditions, provided that an element in the `Map` refers to a condition.
	`Symbol`	The name of the condition references another symbol and should be set to read access with its state.
	`Inverted`	The interpretation of the conditions is inverted. For example, if a symbol value is referenced, a `false` instead of a `true` will restrict read access.
	`CreateLatch`	The entry generates a flag in an internal flag table. If this value is set to `true`, no condition is triggered, but only a flag value is generated.
	`Latch`	Flag value that triggers the condition.

NuGet package: Beckhoff.TwinCAT.HMI.Plastic.Functions

Available: since version 12.22.0

Use: TC3 Plastic Application HMI Projects