SystemEnergyBasic - Functional Description
Type: |
Function block |
Available as of: |
V2.0.3.0 |
The function block SystemEnergyBasic returns the energy information of the system avatar. Resets the energy registers of the system avatar. Sets the energy preset values of the system avatar.
Input |
Data type |
Description |
---|---|---|
iq_TeSysIslandRef |
FB_TeSys_island |
Reference to the TeSys island device. |
i_xExecute |
BOOL |
Upon a rising edge of this input, the function block starts the execution. The outputs q_xDone, q_xError, q_etResult, and q_etResultMsg are reset with the falling edge of i_xExecute. Refer to Behavior of Function Blocks with the Input i_xExecute. |
i_xResetReactiveEnergy |
BOOL |
If this input is set to TRUE, the value of the parameter q_udiReactiveEnergy is reset. |
i_xResetActiveEnergy |
BOOL |
If this input is set to TRUE, the value of the parameter q_udiActiveEnergy is reset. |
Output |
Data type |
Description |
---|---|---|
q_xError |
BOOL |
If this output is set to TRUE, an error has been detected. For details, refer to q_etResult and q_etResultMsg. |
q_etResult |
Provides diagnostic and status information as a numeric value. |
|
q_sResultMsg |
STRING[30] |
Provides additional diagnostic and status information as a text message. |
q_xBusy |
BOOL |
If this output is set to TRUE, the function block execution is in progress. |
q_xDone |
BOOL |
If this output is set to TRUE, the execution has been completed successfully. |
q_udiActiveEnergy |
UDINT |
Total active energy value for all avatars in the system with Energy Monitoring Enabled. (Unit: Wh) |
q_udiReactiveEnergy |
UDINT |
Total reactive energy value for all avatars in the system with Energy Monitoring Enabled. (Unit: Wh) |
q_udiToUActiveEnergyChannel1 |
UDINT |
Channel 1: Returns the ToU (Time of Use) total active energy value that has been accumulated while the channel is enabled/active. |
... |
... |
... |
q_udiToUActiveEnergyChannel4 |
UDINT |
Channel 4: Returns the ToU (Time of Use) total active energy value that has been accumulated while the channel is enabled/active. |