Skip to content

Commit

Permalink
Automated markdown-lint fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Bot committed Oct 7, 2023
1 parent bf32680 commit e73f46c
Show file tree
Hide file tree
Showing 4 changed files with 188 additions and 205 deletions.
75 changes: 35 additions & 40 deletions docs/conf2.proto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,14 @@
## Imports

| Import | Description |
|--------|-------------|


| ------ | ----------- |

## Options

| Name | Value | Description |
|------------|-----------|-------------|
| ---------- | --------- | ----------- |
| go_package | ./conf/v1 | |




### Conf2Frame Diagram

```mermaid
Expand All @@ -35,6 +30,7 @@ Conf2Frame --> `Config`
Conf2Frame --> `Conf2Header`
```

### Conf2Header Diagram

```mermaid
Expand All @@ -54,6 +50,7 @@ class Conf2Header {
}
```

### Config Diagram

```mermaid
Expand All @@ -80,55 +77,53 @@ class Config {
```

## Message: Conf2Frame

<div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: conf.v1.Conf2Frame</div>

<div class="comment"><span>Configuration frame 2</span><br/></div>

| Field | Ordinal | Type | Label | Description |
|-----------|---------|-------------|----------|-------------------------------|
| DATA_RATE | 3 | uint32 | | Rate of data transmission |
| configs | 2 | Config | Repeated | Set of PMU configurations |
| header | 1 | Conf2Header | | Configuration frame 2 header |

| Field | Ordinal | Type | Label | Description |
| --------- | ------- | ----------- | -------- | ---------------------------- |
| DATA_RATE | 3 | uint32 | | Rate of data transmission |
| configs | 2 | Config | Repeated | Set of PMU configurations |
| header | 1 | Conf2Header | | Configuration frame 2 header |

## Message: Conf2Header

<div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: conf.v1.Conf2Header</div>

<div class="comment"><span>Configuration frame 2 header</span><br/></div>

| Field | Ordinal | Type | Label | Description |
|-----------|---------|--------|-------|------------------------------------------------------|
| FRACSEC | 5 | uint32 | | Fraction of Second and Message Time Quality |
| FRAMESIZE | 2 | uint32 | | Number of bytes in the frame |
| IDCODE | 3 | uint32 | | Stream source ID number |
| NUM_PMU | 7 | uint32 | | The number of PMUs included in the data frame |
| SOC | 4 | uint32 | | SOC time stamp |
| SYNC | 1 | uint32 | | Sync byte followed by frame type and version number |
| TIME_BASE | 6 | uint32 | | Resolution of FRACSEC time stamp |

| Field | Ordinal | Type | Label | Description |
| --------- | ------- | ------ | ----- | --------------------------------------------------- |
| FRACSEC | 5 | uint32 | | Fraction of Second and Message Time Quality |
| FRAMESIZE | 2 | uint32 | | Number of bytes in the frame |
| IDCODE | 3 | uint32 | | Stream source ID number |
| NUM_PMU | 7 | uint32 | | The number of PMUs included in the data frame |
| SOC | 4 | uint32 | | SOC time stamp |
| SYNC | 1 | uint32 | | Sync byte followed by frame type and version number |
| TIME_BASE | 6 | uint32 | | Resolution of FRACSEC time stamp |

## Message: Config

<div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: conf.v1.Config</div>

<div class="comment"><span>Single PMU configuration according to Configuration frame 2</span><br/></div>

| Field | Ordinal | Type | Label | Description |
|---------|---------|--------|----------|----------------------------------------|
| ANNMR | 5 | uint32 | | Number of analog values |
| ANUNIT | 9 | uint32 | Repeated | Conversion factor for analog channels |
| CFGCNT | 12 | uint32 | | Configuration change count |
| CHNAM | 7 | string | | Phasor and channel names |
| DGNMR | 6 | uint32 | | Number of digital status words |
| DIGUNIT | 10 | uint32 | Repeated | Mask words for digital status words |
| FNOM | 11 | uint32 | | Nominal line frequency code and flags |
| FORMAT | 3 | uint32 | | Data format within data frame |
| IDCODE | 2 | uint32 | | Data source ID number |
| PHNMR | 4 | uint32 | | Number of phasors |
| PHUNIT | 8 | uint32 | Repeated | Conversion factor for phasor channels |
| STN | 1 | string | | Station name |



| Field | Ordinal | Type | Label | Description |
| ------- | ------- | ------ | -------- | ------------------------------------- |
| ANNMR | 5 | uint32 | | Number of analog values |
| ANUNIT | 9 | uint32 | Repeated | Conversion factor for analog channels |
| CFGCNT | 12 | uint32 | | Configuration change count |
| CHNAM | 7 | string | | Phasor and channel names |
| DGNMR | 6 | uint32 | | Number of digital status words |
| DIGUNIT | 10 | uint32 | Repeated | Mask words for digital status words |
| FNOM | 11 | uint32 | | Nominal line frequency code and flags |
| FORMAT | 3 | uint32 | | Data format within data frame |
| IDCODE | 2 | uint32 | | Data source ID number |
| PHNMR | 4 | uint32 | | Number of phasors |
| PHUNIT | 8 | uint32 | Repeated | Conversion factor for phasor channels |
| STN | 1 | string | | Station name |

<!-- Created by: Proto Diagram Tool -->
<!-- https://github.com/GoogleCloudPlatform/proto-gen-md-diagrams -->
117 changes: 56 additions & 61 deletions docs/data.proto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,72 +5,67 @@
## Imports

| Import | Description |
|--------|-------------|


| ------ | ----------- |

## Options

| Name | Value | Description |
|------------|-----------|-------------|
| ---------- | --------- | ----------- |
| go_package | ./data/v1 | |



## Enum: DataType

<div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: data.v1.DataType</div>

<div class="comment"><span>The collection of Data Types defined so far. They are useful to map</span><br/><span>measurements to their rappresentation. This is important since all measurements</span><br/><span>are any how cast to UINT64 in the real time platform</span><br/></div>

| Name | Ordinal | Description |
|---------------------------------------|---------|-------------------------------------------------------------|
| DATA_TYPE_UNSPECIFIED | 0 | No type define |
| DATA_TYPE_ACTIVE_POWER | 1 | Active Power. It maps to an Analog. |
| DATA_TYPE_ANGLE | 2 | Angle. It maps to an Analog. |
| DATA_TYPE_AUTOMATIC | 3 | Auomatic. It maps to Discrete (True or False). |
| DATA_TYPE_BOOLEAN | 4 | Booleam. It maps to Discrete (True or False). |
| DATA_TYPE_CONFIG_CHANGE | 5 | Configuration change. It maps to Discrete (True or False). |
| DATA_TYPE_CURRENT_SEQUENCE_NEGATIVE | 6 | PHASOR |
| DATA_TYPE_CURRENT_SEQUENCE_POSITIVE | 7 | PHASOR |
| DATA_TYPE_CURRENT_SEQUENCE_ZERO | 8 | PHASOR |
| DATA_TYPE_DATA_ERROR | 9 | DISCRETE (True or False) |
| DATA_TYPE_DATA_MODIFIED | 10 | DISCRETE (True or False) |
| DATA_TYPE_DATA_SORTING | 11 | DISCRETE |
| DATA_TYPE_ENERGY | 12 | ANALOG |
| DATA_TYPE_FREQUENCY | 13 | ANALOG |
| DATA_TYPE_LINE_CURRENT | 14 | ANALOG |
| DATA_TYPE_LINE_TO_LINE_VOLTAGE | 15 | ANALOG |
| DATA_TYPE_LOCAL_OPERATION | 16 | DISCRETE |
| DATA_TYPE_OPERATION_COUNT | 17 | DISCRETE |
| DATA_TYPE_PACKET_LATENCY | 18 | ANALOG |
| DATA_TYPE_PHASE_VOLTAGE | 19 | ANALOG |
| DATA_TYPE_PHASOR_CURRENT | 20 | PHASOR |
| DATA_TYPE_PHASOR_VOLTAGE | 21 | PHASOR |
| DATA_TYPE_PMU_SYNC | 22 | DISCRETE (True or False) |
| DATA_TYPE_PMU_TIME_QUALITY | 23 | DISCRETE |
| DATA_TYPE_PMU_TRIGGER_DETECTED | 24 | DISCRETE (True or False) |
| DATA_TYPE_POWER | 25 | ANALOG |
| DATA_TYPE_POWER_FACTOR | 26 | ANALOG |
| DATA_TYPE_PRESSURE | 27 | ANALOG |
| DATA_TYPE_RATE_OF_CHANGE_OF_FREQUENCY | 28 | ANALOG |
| DATA_TYPE_REACTIVE_POWER | 29 | ANALOG |
| DATA_TYPE_SWITCH_POSITION | 30 | DISCRETE (True or False) |
| DATA_TYPE_TAP_POSITION | 31 | DISCRETE |
| DATA_TYPE_TEMPERATURE | 32 | ANALOG |
| DATA_TYPE_THREE_PHASE_ACTIVE_POWER | 33 | ANALOG |
| DATA_TYPE_THREE_PHASE_CURRENT | 34 | ANALOG |
| DATA_TYPE_THREE_PHASE_POWER | 35 | ANALOG |
| DATA_TYPE_THREE_PHASE_POWER_FACTOR | 36 | ANALOG |
| DATA_TYPE_THREE_PHASE_REACTIVE_POWER | 37 | ANALOG |
| DATA_TYPE_TRIGGER_REASON | 38 | DISCRETE |
| DATA_TYPE_UNLOCKED_TIME | 39 | DISCRETE |
| DATA_TYPE_VOLTAGE_SEQUENCE_NEGATIVE | 40 | PHASOR |
| DATA_TYPE_VOLTAGE_SEQUENCE_POSITIVE | 41 | PHASOR |
| DATA_TYPE_VOLTAGE_SEQUENCE_ZERO | 42 | PHASOR |
| DATA_TYPE_DISCRETE | 43 | DISCRETE |
| DATA_TYPE_ANALOG | 44 | ANALOG |


| Name | Ordinal | Description |
| ------------------------------------- | ------- | ---------------------------------------------------------- |
| DATA_TYPE_UNSPECIFIED | 0 | No type define |
| DATA_TYPE_ACTIVE_POWER | 1 | Active Power. It maps to an Analog. |
| DATA_TYPE_ANGLE | 2 | Angle. It maps to an Analog. |
| DATA_TYPE_AUTOMATIC | 3 | Auomatic. It maps to Discrete (True or False). |
| DATA_TYPE_BOOLEAN | 4 | Booleam. It maps to Discrete (True or False). |
| DATA_TYPE_CONFIG_CHANGE | 5 | Configuration change. It maps to Discrete (True or False). |
| DATA_TYPE_CURRENT_SEQUENCE_NEGATIVE | 6 | PHASOR |
| DATA_TYPE_CURRENT_SEQUENCE_POSITIVE | 7 | PHASOR |
| DATA_TYPE_CURRENT_SEQUENCE_ZERO | 8 | PHASOR |
| DATA_TYPE_DATA_ERROR | 9 | DISCRETE (True or False) |
| DATA_TYPE_DATA_MODIFIED | 10 | DISCRETE (True or False) |
| DATA_TYPE_DATA_SORTING | 11 | DISCRETE |
| DATA_TYPE_ENERGY | 12 | ANALOG |
| DATA_TYPE_FREQUENCY | 13 | ANALOG |
| DATA_TYPE_LINE_CURRENT | 14 | ANALOG |
| DATA_TYPE_LINE_TO_LINE_VOLTAGE | 15 | ANALOG |
| DATA_TYPE_LOCAL_OPERATION | 16 | DISCRETE |
| DATA_TYPE_OPERATION_COUNT | 17 | DISCRETE |
| DATA_TYPE_PACKET_LATENCY | 18 | ANALOG |
| DATA_TYPE_PHASE_VOLTAGE | 19 | ANALOG |
| DATA_TYPE_PHASOR_CURRENT | 20 | PHASOR |
| DATA_TYPE_PHASOR_VOLTAGE | 21 | PHASOR |
| DATA_TYPE_PMU_SYNC | 22 | DISCRETE (True or False) |
| DATA_TYPE_PMU_TIME_QUALITY | 23 | DISCRETE |
| DATA_TYPE_PMU_TRIGGER_DETECTED | 24 | DISCRETE (True or False) |
| DATA_TYPE_POWER | 25 | ANALOG |
| DATA_TYPE_POWER_FACTOR | 26 | ANALOG |
| DATA_TYPE_PRESSURE | 27 | ANALOG |
| DATA_TYPE_RATE_OF_CHANGE_OF_FREQUENCY | 28 | ANALOG |
| DATA_TYPE_REACTIVE_POWER | 29 | ANALOG |
| DATA_TYPE_SWITCH_POSITION | 30 | DISCRETE (True or False) |
| DATA_TYPE_TAP_POSITION | 31 | DISCRETE |
| DATA_TYPE_TEMPERATURE | 32 | ANALOG |
| DATA_TYPE_THREE_PHASE_ACTIVE_POWER | 33 | ANALOG |
| DATA_TYPE_THREE_PHASE_CURRENT | 34 | ANALOG |
| DATA_TYPE_THREE_PHASE_POWER | 35 | ANALOG |
| DATA_TYPE_THREE_PHASE_POWER_FACTOR | 36 | ANALOG |
| DATA_TYPE_THREE_PHASE_REACTIVE_POWER | 37 | ANALOG |
| DATA_TYPE_TRIGGER_REASON | 38 | DISCRETE |
| DATA_TYPE_UNLOCKED_TIME | 39 | DISCRETE |
| DATA_TYPE_VOLTAGE_SEQUENCE_NEGATIVE | 40 | PHASOR |
| DATA_TYPE_VOLTAGE_SEQUENCE_POSITIVE | 41 | PHASOR |
| DATA_TYPE_VOLTAGE_SEQUENCE_ZERO | 42 | PHASOR |
| DATA_TYPE_DISCRETE | 43 | DISCRETE |
| DATA_TYPE_ANALOG | 44 | ANALOG |

### DataType Diagram

Expand Down Expand Up @@ -130,6 +125,7 @@ class DataType{
DATA_TYPE_ANALOG
}
```

### Data Diagram

```mermaid
Expand All @@ -149,6 +145,7 @@ class Data {
Data --> `DataType`
```

### DataSet Diagram

```mermaid
Expand All @@ -168,29 +165,27 @@ DataSet .. ` Data`
```

## Message: Data

<div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: data.v1.Data</div>

<div class="comment"><span>A single data. It has:</span><br/><span>- a given data type,</span><br/><span>- a point in time of measurement (encoded as int64 using Unix Epoc),</span><br/><span>- a value (encoded as uint64)</span><br/></div>

| Field | Ordinal | Type | Label | Description |
|------------|---------|----------|----------|-------------|
| ---------- | ------- | -------- | -------- | ----------- |
| dataType | 1 | DataType | | |
| measuredAt | 2 | int64 | | |
| value | 3 | uint64 | Optional | |


## Message: DataSet

<div style="font-size: 12px; margin-top: -10px;" class="fqn">FQN: data.v1.DataSet</div>

<div class="comment"><span>A set of data:</span><br/><span>- the id of the procuder of the data</span><br/><span>- the map containing data</span><br/></div>

| Field | Ordinal | Type | Label | Description |
|------------|---------|--------------|-------|-------------|
| ---------- | ------- | ------------ | ----- | ----------- |
| data | 2 | string, Data | Map | |
| producerId | 1 | string | | |




<!-- Created by: Proto Diagram Tool -->
<!-- https://github.com/GoogleCloudPlatform/proto-gen-md-diagrams -->
Loading

0 comments on commit e73f46c

Please sign in to comment.