Skip to content

Commit fd3f652

Browse files
committed
add UB sensor PF output to docs
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
1 parent ef8081c commit fd3f652

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/user_manual/components.md

+12
Original file line numberDiff line numberDiff line change
@@ -569,6 +569,10 @@ with the highest probability.
569569
| ----------------- | --------- | ---- | ------------------------- | :------: | :------: | :---------------: |
570570
| `measured_object` | `int32_t` | - | ID of the measured object | &#10004; | &#10060; | a valid object ID |
571571

572+
#### Output
573+
574+
A sensor only has output for state estimation. For other calculation types, sensor output is undefined.
575+
572576
### Generic Voltage Sensor
573577

574578
* type name: `generic_voltage_sensor`
@@ -603,6 +607,10 @@ voltage is a line-to-line voltage. In a `asym_voltage_sensor` the measured volta
603607

604608
##### Steady state output
605609

610+
```{note}
611+
A sensor only has output for state estimation. For other calculation types, sensor output is undefined.
612+
```
613+
606614
| name | data type | unit | description |
607615
| ------------------ | ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
608616
| `u_residual` | `RealValueOutput` | volt (V) | residual value between measured voltage magnitude and calculated voltage magnitude |
@@ -688,6 +696,10 @@ See the documentation on [state estimation calculation methods](calculations.md#
688696

689697
##### Steady state output
690698

699+
```{note}
700+
A sensor only has output for state estimation. For other calculation types, sensor output is undefined.
701+
```
702+
691703
| name | data type | unit | description |
692704
| ------------ | ----------------- | -------------------------- | ---------------------------------------------------------------------------- |
693705
| `p_residual` | `RealValueOutput` | watt (W) | residual value between measured active power and calculated active power |

0 commit comments

Comments
 (0)