====== Modulated Source (v1.0) ======

{{:cs:mervis-ide:35-help:modulatedstage.png}}

==== Full Name ====

Lib.Mervis.v1_0.ModulatedStage

===== Description =====

Block used for controlling the performance of a general modulated source.

==== Required Project References ====

  * Lib.Mervis

===== Usage in ST =====

<code>
program test
    var
        modulatedStage: lib.mervis.v1_0.ModulatedStage;
    end_var

    modulatedStage();
end_program
</code>

===== Description of Inputs and Outputs =====

|Inputs           |Name                                                         |Data Type                                |Retain|Required Connection                                                                  |Meaning|
|OperatingMode    |[[OperatingModeType.htm|Lib.Mervis.v1_0.OperatingModeType]]   |Yes      |No    |Source operating mode                                                               |      |
|ManualPower      |real                                                          |Yes      |No    |Source power in manual mode                                                         |      |
|StageDemand      |[[StageControlType_v1.1.htm|Lib.Mervis.v1_1.StageControlType]]|No       |Yes   |Combined demand from the [[CascadeController_v1.1.htm|cascade controller]]           |      |
|Running          |bool                                                          |No       |No    |Feedback signal of source operation                                                 |      |
|Failure          |bool                                                          |No       |No    |Feedback signal of source failure                                                   |      |
|ResetRuntime     |bool                                                          |No       |No    |Reset runtime hours                                                                 |      |
|Xp               |real                                                          |No       |No    |PI controller - proportional band                                                   |      |
|Ti               |real                                                          |No       |No    |PI controller - integral time                                                       |      |
|FailureDelay     |time                                                          |No       |No    |Interval waiting for active source operation feedback                               |      |
|FailureCountLimit|uint                                                          |No       |No    |Number of consecutive source errors before it is permanently marked as non-functional|      |
|FailureTimeout   |time                                                          |No       |No    |Time after an unsuccessful source start before retrying                             |      |
|LimitingXp       |real                                                          |No       |No    |PI controller for limiting the maximum output temperature - proportional band       |      |
|LimitingTi       |real                                                          |No       |No    |PI controller for limiting the maximum output temperature - integral time           |      |
|RunTimeSource    |[[RunTimeSourceType.htm|Lib.Mervis.v1_0.RunTimeSourceType]]   |No       |No    |Determines how the source runtime hours are counted                                 |      |


|Outputs       |Name                                                         |Data Type                                                                 |Meaning|
|State         |[[StageInfoType_v1.1.htm|Lib.Mervis.v1_1.StageInfoType]]     |Combined source state to the [[CascadeController_v1.1.htm|cascade controller]]|      |
|Demand        |real                                                         |Required source power                                                     |      |
|RunTimeInHours|udint                                                        |Source runtime in whole hours                                             |      |
|FailureOutput |bool                                                         |Source fault                                                              |      |
|AlarmsStatus  |[[AlarmsStatus.htm|Lib.Mervis.v1_0.AlarmsStatus]]            |Combined interface for alarm indication                                   |      |
|RunTime       |time                                                         |Source runtime                                                            |      |


|Blocks    |Name                                                  |Data Type                                                                                                                                                      |Meaning|
|FailureFb|[[FailureDetector.htm|Lib.Mervis.v1_0.FailureDetector]]|Block for evaluating source failure                                                                                                                            |      |
|Alarms   |[[AlarmsExtender1.htm|Lib.Mervis.v1_0.AlarmsExtender1]]|Alarm function block\\ \\ |Alarm Input|[[AlarmsPriorities.htm|Priority]]|Meaning        |\\ |Alarm1        |32/33                            |Source fault||      |


===== Detailed Function Description =====

TODO

===== Usage Example =====