Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fault messages as set of events, rather than single event with multiple status #63

Merged
merged 13 commits into from
Jun 19, 2024
Merged

Fault messages as set of events, rather than single event with multiple status #63

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4013c8a
status as set of events, rather than single event with multiple status
chicco785 Jun 19, 2024
f63e614
Buf re-generated protos
Jun 19, 2024
719dd8a
Update fault.proto
chicco785 Jun 19, 2024
ffc76a8
Merge branch 'fault-messages-as-events' of https://github.com/zaphiro…
chicco785 Jun 19, 2024
2b13d2e
Buf re-generated protos
Jun 19, 2024
f481940
Update fault.proto
chicco785 Jun 19, 2024
fc3d65a
Merge branch 'fault-messages-as-events' of https://github.com/zaphiro…
chicco785 Jun 19, 2024
1f65df6
Buf re-generated protos
Jun 19, 2024
81c5c3e
Update fault.proto
chicco785 Jun 19, 2024
84b57ec
Merge branch 'fault-messages-as-events' of https://github.com/zaphiro…
chicco785 Jun 19, 2024
b873448
Buf re-generated protos
Jun 19, 2024
82d5664
docs(release_notes): update RELEASE_NOTES.md [dependabot skip]
MarcoPignati Jun 19, 2024
8ff4246
docs(release_notes): update RELEASE_NOTES.md [dependabot skip]
chicco785 Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 41 additions & 21 deletions docs/fault.proto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,20 @@ This message is modeled after [CIM PhaseCode](https://zepben.github.io/evolve/do
| `PHASE_CODE_XYN` | 25 | Two unknown non-neutral phases plus neutral. |


## Enum: FaultStatus
## Enum: FaultEventType

**FQN**: zaphiro.grid.v1.FaultStatus
**FQN**: zaphiro.grid.v1.FaultEventType

The collection of Fault Status defined so far.
The collection of Fault Event Types defined so far.


| Name | Ordinal | Description |
|----------------------------------|---------|----------------------------------------------------------------------------------|
| `FAULT_STATUS_UNSPECIFIED` | 0 | No status defined |
| `FAULT_STATUS_STARTED` | 1 | Fault started |
| `FAULT_STATUS_ENDED_AND_LOCATED` | 2 | Fault was located |
| `FAULT_STATUS_ENDED` | 3 | Fault ended |
| `FAULT_STATUS_UNKNOWN` | 4 | Information available don't allow us to know if the Fault is active or complete |
| Name | Ordinal | Description |
|--------------------------------|---------|----------------------------------------------------------------------------------|
| `FAULT_EVENT_TYPE_UNSPECIFIED` | 0 | No status defined |
| `FAULT_EVENT_TYPE_STARTED` | 1 | Fault started |
| `FAULT_EVENT_TYPE_LOCATED` | 2 | Fault located |
| `FAULT_EVENT_TYPE_ENDED` | 3 | Fault ended |
| `FAULT_EVENT_TYPE_UNKNOWN` | 4 | Information available don't allow us to know if the Fault is active or complete |



Expand Down Expand Up @@ -163,20 +163,20 @@ class PhaseCode{
PHASE_CODE_XYN
}
```
### FaultStatus Diagram
### FaultEventType Diagram

```mermaid
classDiagram
direction LR
%% The collection of Fault Status defined so far.
%% The collection of Fault Event Types defined so far.

class FaultStatus{
class FaultEventType{
<<enumeration>>
FAULT_STATUS_UNSPECIFIED
FAULT_STATUS_STARTED
FAULT_STATUS_ENDED_AND_LOCATED
FAULT_STATUS_ENDED
FAULT_STATUS_UNKNOWN
FAULT_EVENT_TYPE_UNSPECIFIED
FAULT_EVENT_TYPE_STARTED
FAULT_EVENT_TYPE_LOCATED
FAULT_EVENT_TYPE_ENDED
FAULT_EVENT_TYPE_UNKNOWN
}
```
### Fault Diagram
Expand All @@ -189,6 +189,10 @@ direction LR
%%
%% This message is modeled after [CIM Fault](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/Fault) according to the extensions defined in the [fault-data-storage](https://github.com/zaphiro-technologies/architecture/blob/main/features/31-fault-data-storage.md#data-structures) feature.
%%
%% Faults messages represent events linked to a given fault (identified by the id). From the point of view of storage the sequence of events may be handled in a way that does not map totally to the single event, e.g. by combining multiple events in a single database row.
%%
%% When a fault is detected, an `Fault` message event of type `FAULT_EVENT_TYPE_STARTED` is generated, when a fault is located (and multiple locations can occur for the same fault) and a `Fault` event message of type `FAULT_EVENT_TYPE_LOCATED` is generated. When a fault ends, a `Fault` event message of type `FAULT_EVENT_TYPE_ENDED` is generated. Certain fields of the Fault event message may be populated only in case of event type `FAULT_EVENT_TYPE_LOCATED` (i.e. `locationProbability`, `measurementTimestamp`).
%%
%% Headers used in rabbitMQ:
%% * `id` (string): id of the `Fault`
%% * `type` (string): always `Fault`
Expand All @@ -201,16 +205,17 @@ class Fault {
+ PhaseConnectedFaultKind kind
+ PhaseCode phases
+ int64 updatedAt
+ FaultStatus status
+ FaultEventType faultEventType
+ Optional~string~ faultyEquipmentId
+ Optional~float~ faultCurrent
+ List~string~ impactedEquipmentIds
+ List~FaultMeasurement~ usedMeasurementIds
+ Optional~int64~ measurementTimestamp
+ Optional~float~ locationProbability
}
Fault --> `PhaseConnectedFaultKind`
Fault --> `PhaseCode`
Fault --> `FaultStatus`
Fault --> `FaultEventType`
Fault --> `FaultMeasurement`

```
Expand All @@ -224,6 +229,8 @@ direction LR
%%
%% This message is modeled after [CIM LineFault](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/LineFault) according to the extensions defined in the [fault-data-storage](https://github.com/zaphiro-technologies/architecture/blob/main/features/31-fault-data-storage.md#data-structures) feature.
%%
%% Certain fields of the `LineFault` event message may be populated only in case of event type `FAULT_EVENT_TYPE_LOCATED` (i.e. `lengthFromTerminal1`, `lengthUncertainty`).
%%
%% Headers used in rabbitMQ:
%% * `id` (string): id of the `Fault`
%% * `type` (string): always `LineFault`
Expand All @@ -233,6 +240,7 @@ direction LR
class LineFault {
+ Fault fault
+ Optional~float~ lengthFromTerminal1
+ Optional~float~ lengthUncertainty
}
LineFault --> `Fault`

Expand All @@ -248,6 +256,8 @@ direction LR
%%
%% This message is modeled after [CIM EquipmentFault](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/EquipmentFault) according to the extensions defined in the [fault-data-storage](https://github.com/zaphiro-technologies/architecture/blob/main/features/31-fault-data-storage.md#data-structures) feature.
%%
%% Certain fields of the `EquipmentFault` event message may be populated only in case of event type `FAULT_EVENT_TYPE_LOCATED` (i.e. `terminalID`).
%%
%% Headers used in rabbitMQ:
%% * `id` (string): id of the `EquipmentFault`
%% * `type` (string): always `LineFault`
Expand Down Expand Up @@ -284,6 +294,10 @@ Abnormal condition causing current flow through conducting equipment, such as ca

This message is modeled after [CIM Fault](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/Fault) according to the extensions defined in the [fault-data-storage](https://github.com/zaphiro-technologies/architecture/blob/main/features/31-fault-data-storage.md#data-structures) feature.

Faults messages represent events linked to a given fault (identified by the id). From the point of view of storage the sequence of events may be handled in a way that does not map totally to the single event, e.g. by combining multiple events in a single database row.

When a fault is detected, an `Fault` message event of type `FAULT_EVENT_TYPE_STARTED` is generated, when a fault is located (and multiple locations can occur for the same fault) and a `Fault` event message of type `FAULT_EVENT_TYPE_LOCATED` is generated. When a fault ends, a `Fault` event message of type `FAULT_EVENT_TYPE_ENDED` is generated. Certain fields of the Fault event message may be populated only in case of event type `FAULT_EVENT_TYPE_LOCATED` (i.e. `locationProbability`, `measurementTimestamp`).

chicco785 marked this conversation as resolved.
Show resolved Hide resolved
Headers used in rabbitMQ:
* `id` (string): id of the `Fault`
* `type` (string): always `Fault`
Expand All @@ -298,12 +312,13 @@ Headers used in rabbitMQ:
| `kind` | 3 | `PhaseConnectedFaultKind` | | The kind of phase fault. |
| `phases` | 4 | `PhaseCode` | | The phases participating in the fault. The fault connections into these phases are further specified by the type of fault. |
| `updatedAt` | 5 | `int64` | | The date and time at which the fault started/located/ended depending on the Fault Status (Unix msec timestamp). |
| `status` | 6 | `FaultStatus` | | The status of the fault. |
| `faultEventType` | 6 | `FaultEventType` | | The type of the fault event. |
| `faultyEquipmentId` | 7 | `string` | Optional | The equipment with the fault. |
| `faultCurrent` | 8 | `float` | Optional | The current associated to the fault. |
| `impactedEquipmentIds` | 9 | `string` | Repeated | The set of IDs of equipments impacted by the fault. |
| `usedMeasurementIds` | 10 | `FaultMeasurement` | Repeated | The set of measurements used to locate the fault. |
| `measurementTimestamp` | 11 | `int64` | Optional | The timestamp of the measurements used to compute the fault location. |
| `locationProbability` | 12 | `float` | Optional | The probability associated to the location. (This is relevant because multiple locations can be returned for a fault) |



Expand All @@ -316,6 +331,8 @@ A fault that occurs on an AC line segment at some point along the length.

This message is modeled after [CIM LineFault](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/LineFault) according to the extensions defined in the [fault-data-storage](https://github.com/zaphiro-technologies/architecture/blob/main/features/31-fault-data-storage.md#data-structures) feature.

Certain fields of the `LineFault` event message may be populated only in case of event type `FAULT_EVENT_TYPE_LOCATED` (i.e. `lengthFromTerminal1`, `lengthUncertainty`).

Headers used in rabbitMQ:
* `id` (string): id of the `Fault`
* `type` (string): always `LineFault`
Expand All @@ -327,6 +344,7 @@ Headers used in rabbitMQ:
|-----------------------|---------|---------|----------|--------------------------------------------------------------------------------------------------------------------------------|
| `fault` | 1 | `Fault` | | The base fault message. |
| `lengthFromTerminal1` | 2 | `float` | Optional | The length to the place where the fault is located starting from terminal with sequence number 1 of the faulted line segment. |
| `lengthUncertainty` | 3 | `float` | Optional | The +/- uncertainty on the reported length. |



Expand All @@ -340,6 +358,8 @@ A fault applied at the terminal, external to the equipment. This class is not us

This message is modeled after [CIM EquipmentFault](https://zepben.github.io/evolve/docs/cim/cim100/TC57CIM/IEC61970/Base/Faults/EquipmentFault) according to the extensions defined in the [fault-data-storage](https://github.com/zaphiro-technologies/architecture/blob/main/features/31-fault-data-storage.md#data-structures) feature.

Certain fields of the `EquipmentFault` event message may be populated only in case of event type `FAULT_EVENT_TYPE_LOCATED` (i.e. `terminalID`).

Headers used in rabbitMQ:
* `id` (string): id of the `EquipmentFault`
* `type` (string): always `LineFault`
Expand Down
Loading