Skip to content

Commit

Permalink
finalise task and data documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@chicco785
chicco785 committed Oct 9, 2023
1 parent 023fbdb commit 52cca51
Show file tree
Hide file tree
Showing 6 changed files with 215 additions and 190 deletions.
1 change: 1 addition & 0 deletions .prettierignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs/*.md
75 changes: 40 additions & 35 deletions docs/conf2.proto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,19 @@
## Imports

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



## Options

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




### Conf2Frame Diagram

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

### Conf2Header Diagram

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

### Config Diagram

```mermaid
Expand All @@ -77,53 +80,55 @@ 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

## 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

## 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 -->
Loading

0 comments on commit 52cca51

Please sign in to comment.