Energy - Functional Description
|
Type: |
Function block |
|
Available as of: |
V2.0.3.0 |
The function block Energy returns the energy information of the selected avatar. Resets the energy registers of the selected avatar. Sets the energy preset values of the selected 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_sAvatarName |
Reference to the avatar defined in the TeSys island configuration. |
|
|
i_xSetActiveEnergy |
BOOL |
Command to set the i_udiSetValueActiveEnergy value to TotalActiveEnergyPreset value. |
|
i_xSetReactiveEnergy |
BOOL |
Command to set the i_udiSetValueReactiveEnergy value to TotalReactiveEnergyPreset value. |
|
i_xRecordToUChannel1 |
BOOL |
Record ToU (Time of Use) channel 1 start command. 0 = no 1 = yes |
|
... |
... |
... |
|
i_xRecordToUChannel4 |
BOOL |
Record ToU (Time of Use) channel 4 start command. 0 = no 1 = yes |
|
i_udiSetValueActiveEnergy |
UDINT |
Value to preset the TotalActiveEnergyPreset (q_udiActiveEnergy), will take effect on a TRUE command to i_xSetActiveEnergy (Unit: Watt-hours) |
|
i_udiSetValueReactiveEnergy |
UDINT |
Value to preset the TotalReactiveEnergyPreset (q_udiReactiveEnergy), will take effect on a TRUE command to i_xSetReactiveEnergy (Unit: VAR-hours) |
|
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 the avatar. (Unit: Wh) |
|
q_udiReactiveEnergy |
UDINT |
Total reactive energy value for the avatar. (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. |
|
q_udiToUReactiveEnergyChannel1 |
UDINT |
Channel 1: Returns the ToU (Time of Use) total reactive energy value that has been accumulated while the channel is enabled/active. NOTE: Not used in this version of function block (will return all 0 s). |
|
... |
... |
... |
|
q_udiToUReactiveEnergyChannel4 |
UDINT |
Channel 4: Returns the ToU (Time of Use) total reactive energy value that has been accumulated while the channel is enabled/active. NOTE: Not used in this version of function block (will return all 0 s). |
