Versions Compared

Old Version 14

changes.mady.by.user Reinhard Mayr (Unlicensed)

Saved on

compared with

New Version 15

changes.mady.by.user Reinhard Mayr (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Changes within this definition file are taking effect immediately. No server restart is required.


Col#NameDescription
1NameThis parameter defines the The name of the XCommand instance. The name must Must be unique.
2Variable groupThis parameter defines the scope where The scope in which the used internal variables of the XCommand are valid. All XCommand instances that are using configured for the same variable group are accessing access the same internal variables. This means that all XCommand instances are sharing share the same internal variables. If left empty, the instance name (column 1) is used as variable group.
3Type

This attribute defines when Specifies under which conditions and circumstances the XCommand shall be triggered. The following types are possibleavailable:

  • "ON_START" means that : the XCommand is executed once when the NETx BMS Core Server starts."
  • ON_TIMER" triggers STOP: the XCommand cyclically (the interval in seconds can be specified in "Options" column)."is executed once when the NETx BMS Core Server stops.
  • ON_INPUT" : executes the XCommand whenever one input item changes its value."
  • ON_TIMER_AND_INPUT" is used for XCommands that shall be triggered cyclically and whenever one input item changes.
  • "ON_STOP" means that the XCommand is executed once when the NETx BMS Core Server stops.
  • "ON_VALUE_CHANGE" means that : the XCommand is only executed when one of the input items are changing.
  • "ON_VALUE_RISING" means that : the XCommand is only executed when one of the input items are changing and the new value is greater than the last one. When working with boolean values, TRUE is higher than FALSE.
  • "ON_VALUE_FALLING" means : that the XCommand is only executed when one of the input items are changing and the new value is lower than the last one. When working with boolean values, TRUE is higher than FALSE.
  • "ON_ABOVE_LIMIT" means that : the XCommand is only executed when one of the input items is above a limit."
  • ON_BELOW_LIMIT" means that : the XCommand is only executed when one of the input items is below a limit.
  • ON_TIMER: the XCommand is cyclically triggered.
  • ON_TIMER_AND_INPUT: the XCommand shall be triggered cyclically and whenever any of the input items changes.
4Options

Depending on the selected type, different options can be specified here:

  • ON_START: no options.
  • ON_STOP: no options.
  • ON_INPUT
    • Trigger on start (default is false). If true, the logic is also executed on server start-up.
    • Synchronous call (default is false). If true, the logic is executed synchronous i.e. no other server tasks or events are triggered until the execution is finished.
  • ON_VALUE_CHANGE
    • Tolerance: value range which must be exceeded between two values in order to trigger the event.
    • Trigger on start (default is false). If true, the logic is also executed on server start-up.
  • ON_VALUE_RISING
    • Tolerance: value range which must be exceeded between two values in order to trigger the event.
    • Once: if enabled, the XCommand is executed a single time after it begins to rise. 
  • ON_VALUE_FALLING
    • Tolerance: value range which must be exceeded between two values in order to trigger the event.
    • Once: if enabled, the XCommand is executed a single time after it begins to fall.
  • ON_ABOVE_LIMIT
    • Limit: value that must be exceeded.
    • Once: if enabled, the command is only executed a single time after the limit is exceeded.
    • Hysteresis
  • ON_BELOW_LIMIT
    • Limit: value that must be exceeded.
    • Once: if enabled, the command is only executed a single time after the limit is exceeded.
    • Hysteresis
  • ON_TIMER
    • Timer type (cyclic or time). If cyclic is selected, the logic will be triggered in a cyclic interval. If time is chosen, the logic will be triggered every day at a given point in time. 
    • Interval: The interval in seconds.
    • Time: The time at which the XCommand shall be executed every day.
  • ON_TIMER_AND_INPUT
    • Timer type (cyclic or time). If cyclic is selected, the logic will be triggered in a cyclic interval. If time is chosen, the logic will be triggered every day at a given point in time. 
    • Interval: The interval in seconds.
    • Time: The time at which the XCommand shall be executed every day.
5XCommandThe parameter defines the XCommand that shall be executed. To assist in selecting the inputs, outputs, and parameters, a dialog is available which can be open via the "..." button.
6InputsThis parameter defines the The inputs of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically.
7OutputsThis parameter defines the The outputs of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically.
8ParametersThis parameter defines the parameters Parameters of the XCommand. If the XCommand is selected via the dialog, this parameter is filled automatically.

...