Skip to content

Commit 06a30fc

Browse files
ca-dJakob Vogelsang
ca-d
and
Jakob Vogelsang
authored
docs: update help content from wiki (#324)
* Initial Home page * Created DataTypeTemplate editor (markdown) * Updated DataTypeTemplate editor (markdown) * Updated DataTypeTemplate editor (markdown) * Updated DataTypeTemplate editor (markdown) * Updated DataTypeTemplate editor (markdown) * Created Guess substation structure (markdown) * Updated Guess substation structure (markdown) * Created Importing IEDs (markdown) * Created _Sidebar (markdown) * Destroyed _Sidebar (markdown) * Created Update GOOSE subscriber info in SCL (markdown) * Created _Sidebar (markdown) * Created Connect Report Control Blocks with ClientLN (markdown) * Updated Connect Report Control Blocks with ClientLN (markdown) * Updated Connect Report Control Blocks with ClientLN (markdown) * Created Merge functionality (markdown) * Created How to install OpenSCD offline (markdown) * Updated How to install OpenSCD offline (markdown) * Updated How to install OpenSCD offline (markdown) * Created Manage save project (markdown) * refactor: remove home screen trick * feat: add home page with table of content * fix: ass missing link in table of content * typo * Updated _Sidebar (markdown) * Add TOC * Restructure TOC * add editor features section * Created SCL Sections (markdown) * add substation page * add Communication page * Updated Communication (markdown) * rename datatypetemplate editor * add Communication page * Updated Home (markdown) * reorder sidebar links * fix typo * doc(template): add start from template help * doc(templates): add draphic to the StartFromTemplate * doc(templates): ass first StartFromScratch page * doc(templates): some correction to StartFrom Scratch * doc(templates): add ValidateTemplate * doc(templates/enumval): How-to use with OpenSCD * doc(templates/enumtype): How-to use with OpenSCD * doc(templates/DataObject): How-to use with OpenSCD * Updated _Sidebar (markdown) * Updated _Sidebar (markdown) * Updated _Sidebar (markdown) * Updated _Sidebar (markdown) * Updated _Sidebar (markdown) * doc(templates/DataAttributeType): add how-to with OpenSCD * doc(templates/DataAttribute): hot-to with OpenSCD * docs(MergeFunctionality): update user documentation * docs(MergeFunctionality): update user documentation * Updated _Sidebar (markdown) * Updated _Sidebar (markdown) * Updated _Sidebar (markdown) * Updated _Sidebar (markdown) * docs(Home): update page * docd: update user doc * dosc(Install): fix typos * dosc(Install): fix typos * docs(Home): update * docs(Home): update * docs(Project workflow): add information * docs(Project workflow): fix links * docs(validators): add infos on validators * docs(validators): add docs for schema validation * dosc(global): add documentation to global features * docs(sidebar): update * docs(sidebar): update * Destroyed MergeFunctionality (markdown) * docs(sidebar): update * docs(substation): improve user doc * docs: clean unused pages * docs(Communication): update structure * docs(IED): update IED related info and structure * docs(sidebar): fix missing link * docs(global function): add XML code editor doc * docs(DataTypeTemplates): add start from templates * docs(DataTypeTemplates): fix missing links * docs(DataTypeTemplates): start from scratch * docs(DataTypeTemplates): add-LNodeType-form-templates * docs(DataTypeTemplates): fix link * docs(Sidebar): remove headings * docs: add starts from templates pages * docs: fix links * docs(EnumType): add EnumType and EnumVal descrition * docs(Enumeration): clean structure * docs: add data attribute type user doc * docs: data object type * docs: add LNodeType user docs * docs: update sidebar * docs: fix references * docs: fix references * docs(DataTypeTemplates): adapt changes to LNodeTypeWizard * chore: delete wiki contents * docs: flatten wiki page hierarchy Co-authored-by: Jakob Vogelsang <[email protected]>
1 parent 5d07886 commit 06a30fc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1164
-191
lines changed

‎public/md/Add-DAType-from-templates.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
As an example this page shows you how to import `DAType` from the templates database. E.g. the `PulseConfig`.
2+
3+
1. Open **Template editor**
4+
2. Click the **Add DAType** button
5+
3. Select *PulseConfig* from **values**
6+
4. Don't forget the **id** field
7+
6. Click on **Save**
8+
9+
OpenSCD automatically imports all element that are required for a valid definition of a `DAType`. When you do that with an empty project your result should look like this
10+
11+
![grafik](https://user-images.githubusercontent.com/66802940/133637394-354eba41-a4b6-4e3c-9458-88b1e608866c.png)

‎public/md/Add-DOType-from-templates.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
As an example this page shows you how to import `DOType` from the templates database.
2+
3+
1. Open **Template editor**
4+
2. Click the **Add DOType** button
5+
3. Select *DPC* from **values**
6+
4. Don't forget the **id** field
7+
6. Click on **Save**
8+
9+
OpenSCD automatically imports all element that are required for a valid definition of a `DOType`. When you do that with an empty project your result should look like this
10+
11+
![grafik](https://user-images.githubusercontent.com/66802940/133636784-d1dbe4e6-7402-479e-8357-9d806d49a785.png)

‎public/md/Add-EnumType-from-templates.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
As an example this page shows you how to import `EnumType` from the templates database.
2+
3+
1. Open **Template editor**
4+
2. Click the **Add EnumType** button
5+
3. Select *BehaviourModeKind* from **values**
6+
4. Don't forget the **id** field
7+
6. Click on **Save**
8+
9+
The templates database contains all enumerations from 7-4, 7-3. This is the list currently added:
10+
11+
`IEC 61850-7-4`
12+
- CtlModelKind
13+
- OriginatorCategoryKind
14+
- MultiplierKind
15+
- AngleReferenceKind
16+
- CurveCharKind
17+
- FaultDirectionKind
18+
- HvReferenceKind
19+
- MonthKind
20+
- OccurrenceKind
21+
- OutputSignalKind
22+
- PeriodKind
23+
- PhaseAngleReferenceKind
24+
- PhaseFaultDirectionKind
25+
- PhaseReferenceKind
26+
- RangeKind
27+
- SboClassKind
28+
- SequenceKind
29+
- SeverityKind
30+
- WeekdayKind
31+
32+
`IEC 61850-7-4`
33+
- BehaviourModeKind
34+
- SIUnitKind
35+
- AdjustmentKind
36+
- AffectedPhasesKind
37+
- AutoReclosingKind
38+
- BreakerOpCapabilityKind
39+
- CalcIntervalKind
40+
- CalcMethodKind
41+
- CalcModeKind
42+
- ClockSourceKind
43+
- ClockSyncKind
44+
- ClockSyncLockingKind
45+
- DirectionModeKind
46+
- FailureDetectionKind
47+
- FaultLoopKind
48+
- FaultMeasuredValueTypeKind
49+
- FilterFunctionKind
50+
- FuseFunctionKind
51+
- HealthKind
52+
- InstrumentTransformerMeasurementRatingKind
53+
- InstrumentTransformerProtectionRatingKind
54+
- LeapSecondKind
55+
- LevelTriggerModeKind
56+
- LiveDeadModeKind
57+
- MaterialKind
58+
- MaterialStateKind
59+
- PFSignKind
60+
- PIDAlgorithmKind
61+
- POWSwitchingCapabilityKind
62+
- ParallelCoilModeKind
63+
- ParallelCtrlModeKind
64+
- ParallelTransfModeKind
65+
- PolarizingQuantityKind
66+
- RecordingModeKind
67+
- RectifierControlModeKind
68+
- ResetCurveKind
69+
- RestraintModeKind
70+
- RetripModeKind
71+
- RotatingMachineStateKind
72+
- RotationalDirectionKind
73+
- RotorThermalStateKind
74+
- SOFEnablingModeKind
75+
- SOFOperationModeKind
76+
- STotalCalcMethodKind
77+
- ScheduleEnablingErrorKind
78+
- ScheduleStateKind
79+
- SetpointEndKind
80+
- StageControlKind
81+
- SwitchFunctionKind
82+
- SwitchingCapabilityKind
83+
- SynchOperationModeKind
84+
- TankFillKind
85+
- TransientPerformanceClassKind
86+
- TpcAppModeKind
87+
- TriggerSourceKind
88+
- TripBehaviourKind
89+
- TripModeKind
90+
- TuningKind
91+
- UnbalanceDetectionKind
92+
- UnblockModeKind
93+
- VoltInterruptDetectionKind
94+
- WeakEndInfeedModeKind

‎public/md/Add-LNodeType-from-templates.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
As an example this page shows you how to import a `LNodeType` `CSWI` from the templates database.
2+
3+
1. Open **Template editor**
4+
2. Click the **Add LNodeType** button
5+
3. Select pre-defined logical node class e.g. _CSWI: ... no process bus(PB)_ as **lnClass**
6+
4. Don't forget the **id** field
7+
5. Click on **Save**
8+
9+
OpenSCD automatically imports all element that are required for a valid definition of a `LNodeType` `CSWI`. When you do that with an empty project your result should look like this
10+
11+
![grafik](https://user-images.githubusercontent.com/66802940/133465609-18195262-31b3-4fae-a514-88a721b30dfb.png)

‎public/md/All-template-editor-wizards.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
The **template editor** allows you to create the elements that combined is the data model. To do this job there are 10 wizards pages for each of the elements you can find in the `DataTypeTemplates` section.
2+
3+
- [EnumType](https://github.com/openscd/open-scd/wiki/Enumeration-EnumType)
4+
- [EnumVal](https://github.com/openscd/open-scd/wiki/Enumeration-EnumVal)
5+
- [EnumVal]()

‎public/md/ClientLN.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
A `ClientLN` is one of 3 elements that are describing connections between IEDs in a SCL file.
2+
3+
### HowTo connect Report with ClientLNs
4+
OpenSCD allows you to connect `ReportControl` via `ClientLN`. The starting point is the **IED** in the **Substation editor**.
5+
6+
<img src="https://user-images.githubusercontent.com/66802940/133250977-03eb956f-fde7-43bc-994c-790b7ec33a2a.png" alt="alt text" width="250">
7+
8+
9+
- Click on a **IED**
10+
- Click on **Add connection** button
11+
- The `ClientLN` wizard open
12+
- On the right hand side you can select the `ReportControl` element(s) in the project
13+
- On the right hand side you can see all logical node in the receiving IED (client).
14+
- All so-called client logical nodes - logical nodes allocated to `AccessPoint` are sorted be be on top.
15+
- `LN0` element are sorted to be at the bottom
16+
- Click on `CONNECT`
17+
18+
![grafik](https://user-images.githubusercontent.com/66802940/133251594-7d552b24-e64f-4875-932a-07c990c0c7ac.png)
19+
20+
> NOTE: When `ClientLN` connections are already present in the `Report Control` block the wizard does not close in **CONNECT**
21+
22+
> NOTE: If the `EnableRpt` `max` attribute is smaller or equal to the `ClientLN` a connection is not possible. The `ReportControl` on the rigth hand side is disabled.
23+
24+
> TIP: You can filter for several terms at same time. The space between terms is acting as a logical AND.
25+

‎public/md/Connect-Report-Control-Blocks-with-ClientLN.md‎

Lines changed: 0 additions & 24 deletions
This file was deleted.

‎public/md/Data-attribute-type-DAType.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
2+
**Add DAType**
3+
4+
<img align="right" src="https://user-images.githubusercontent.com/66802940/132105466-55a9ace1-84d5-4ab3-83b8-ad4cb4195cf7.png" alt="alt text" width="250">
5+
6+
1. Navigate to the list of `DAType`'s in the **template editor**
7+
2. Click on **Add DAType**
8+
3. Select either a `DAType` from the template library or an empty on (empty **value** field)
9+
10+
*Settings*:
11+
1. **id***: make sure that id is unique in the whole project.
12+
2. **desc**: user-defined description field
13+
14+
*From IEC 61850*
15+
16+
OpenSCD templates contains all data attribute types from IEC&#8239;61850&#x2011;7&#x2011;3. Other than `EnumType` most pre-defined `DAType` have more flexibility in their definition. As an example you can see the definition of the `AnalogueValue` as defined in the [NSD]() files.
17+
18+
```
19+
<ConstructedAttribute name="AnalogueValue"
20+
titleID="IEC61850_7_3.AnalogueValue::AnalogueValue.cl.title">
21+
<SubDataAttribute name="i"
22+
type="INT32"
23+
...
24+
presCond="AtLeastOne"
25+
presCondArgs="1"/>
26+
<SubDataAttribute name="f"
27+
type="FLOAT32"
28+
...
29+
presCond="AtLeastOne"
30+
presCondArgs="1"/>
31+
</ConstructedAttribute>
32+
```
33+
34+
The definition especially the attribute `presCond` gives the freedom to decide if one or both can be children of the `AnalogueValue`. This means for you as a user that you have to decide how your `AnalogueValue` can look like. For OpenSCD templates this means that most `DAType` contain all possible children. From there on you can remove children so that the `DAType` does fit your needs.
35+
36+
> NOTE: `DAType` in the OpenSCD templates contain often all possible children. Please check if you really need all of them. Check the definition of the `DAType` definition of the standard.
37+
38+
39+
*User-defined*
40+
41+
An black `DAType` is added to the project, that in a lot of cases is invalid so do not stop here.
42+
43+
&nbsp;
44+
45+
**Edit DAType**
46+
47+
<img align="right" src="https://user-images.githubusercontent.com/66802940/132105442-e3518994-5369-4342-ab1a-8a70a9133ed1.png" alt="alt text" width="250">
48+
49+
1. Navigate to the `DAType`'s list in the **template editor**
50+
2. Click on the `DAType` you want to edit
51+
52+
*Settings*:
53+
54+
1. **id***: make sure that id is unique in the whole project.
55+
2. **desc**: user-defined description field
56+
3. List of all child `BDA`. The item shows the `id` as well as the type - `bType`. When the type starts with **#** than the `BDA` is either a constructed attribute or an enumeration.
57+
58+
59+
*Example*:
60+
```
61+
<DAType id="OpenSCD_Originator">
62+
<BDA name="orCat" bType="Enum" type="OriginatorCategoryKind"/>
63+
<BDA name="orIdent" bType="Octet64"/>
64+
</DAType>
65+
```
66+
67+
&nbsp;
68+
69+
**Remove EnumType**
70+
71+
1. Open the `DAType` you want to remove **Edit DAType**
72+
2. Click on **Remove** button
73+
74+
> **WARNING**: OpenSCD does not check for validity before removal so be careful!
75+

‎public/md/Data-attribute-type-child-BDA.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
2+
**Add new BDA**
3+
4+
<img align="right" src="https://user-images.githubusercontent.com/66802940/132066144-6efe36e8-544e-487d-9bdf-70829ab878fd.png" alt="alt text" width="250">
5+
6+
7+
You can use OpenSCD to add new `BDA`s to an existing `DAType`.
8+
1. Navigate to the `DAType` you want to edit and open the **Edit DAType** wizard.
9+
2. Click on **DATA ATTRIBUTE** button in the middle of the wizard.
10+
11+
*Settings*:
12+
1. **name***: If you choose to have a `BDA` from IEC&#8239;61850 namespace consult IEC&#8239;61850&#x2011;7&#x2011;4. Otherwise make sure to start with an lower case latter [a-z]
13+
2. **desc**: user-defined description field
14+
3. **bType***: The attributes basic type. If *Enum* or *Struct* the **type** field may not be empty.
15+
4. **type***: Type is defined as string in the SCL but is a selector in OpenSCD. If **bType** is *Struct* the selector shows all `DAType` - `id`'s in the project. Without existing `DAType` in the project you cannot create a `BDA`. If **bType** is *Enum* the selector shows all `EnumType` - `id`'s in the project.
16+
5. **sAddr**: user-defined string to describe a short address
17+
6. **valKind**: Might be missing and if not must be either true or false.
18+
7. **valImport**:
19+
8. **Val**: Value element that allow you to pre-define the value offline. This can be added to any data attribute (`DA` or `BDA`).
20+
21+
> **NOTE:** `Val` definition does not make sense for all function constraints (`FC`). E.g status type data attribute as `stVal` is not very useful. For other data attributes it perfectly makes sense to pre-define the value. E.g. the `ctlModel`
22+
23+
> **CHECKS**: Missing or wrong `name` is covered by schema validator. Missing or wrong `type` is covered by template validator.
24+
25+
26+
<img align="right" src="https://user-images.githubusercontent.com/66802940/132106055-277fff5a-9b59-4454-be8d-fd4d4049d056.png" alt="alt text" width="250">
27+
28+
**Edit BDA**
29+
30+
You can use OpenSCD to manipulate existing `BDA`.
31+
1. Navigate to `DAType` list in **template editor**
32+
2. Click on `DAType` that contains the `BDA` you want to edit
33+
2. Click on child `BDA` you want to edit
34+
35+
*Settings*:
36+
37+
The settings are the same a in the **Add BDA** wizard with the difference that there is a remove button.
38+
39+
*Example:*
40+
```
41+
<BDA name="orCat" bType="Enum" type="OpenSCD_OriginatorCategoryKind">
42+
```
43+
&nbsp;
44+
45+
**Remove BDA**
46+
47+
1. Open **Edit DA** wizard
48+
2. Click on **Remove** button
49+
50+
> **WARNING**: OpenSCD does not check for validity before removal so be careful!
51+
52+
53+
54+
55+
56+
57+
58+
59+
60+
61+

0 commit comments

Comments
 (0)