Skip to content

Commit e60cbd4

Browse files
JakobVogelsangJakobVogelsang
authored
doc(menu/help): update and user doc (openscd#998)
1 parent d88b7d2 commit e60cbd4

33 files changed

+1648
-52
lines changed

‎public/md/Bay.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
**Create Bay**
2+
3+
<img align="right" width="250" alt="grafik" src="https://user-images.githubusercontent.com/66802940/183960578-a50a489c-9e0e-489e-bdb5-aeb97f240082.png">
4+
5+
To create a new `Bay` element within the parent `VoltageLevel`
6+
7+
- Navigate to the **Substation** editor
8+
- Select the parent **VoltageLevel** you want to add the bay to
9+
- Fill in all required value
10+
- Click on **Add**
11+
12+
The create wizard allows to set
13+
14+
- `name`: unique identified of the Bay in the parent `VoltageLevel`
15+
- `desc`: human readable description
16+
17+
**Edit Bay**
18+
19+
<img width="250" alt="grafik" src="https://user-images.githubusercontent.com/66802940/183960790-d6c32f25-e829-4990-81be-2372c75fccbe.png">
20+
21+
To edit a `Bay` element:
22+
23+
- Navigate to the **Substation** editor
24+
- Select the **Bay** you want to edit
25+
- Click on the **edit** button
26+
- Make the changes and click **Save**
27+
28+
The element `Bay` has two attributes
29+
30+
- `name`: unique identified of the Bay in the parent `VoltageLevel`
31+
- `desc`: human readable description
32+
33+
**Remove Bay**
34+
35+
To remove an existing `Bay` element within the parent `VoltageLevel`
36+
37+
- Navigate to the **Substation** editor
38+
- Select the **Bay** you want to remove
39+
- Click on the **delete** button

‎public/md/ClientLN.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
1-
A `ClientLN` is one of 3 elements that are describing connections between IEDs in a SCL file.
1+
A `ClientLN` is one of 3 elements that are describing connections between IEDs in a SCL file.
22

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**.
3+
**HowTo connect Report with ClientLNs**
54

6-
<img src="https://user-images.githubusercontent.com/66802940/133250977-03eb956f-fde7-43bc-994c-790b7ec33a2a.png" alt="alt text" width="250">
5+
OpenSCD allows you to connect `ReportControl` via `ClientLN`. The starting point is the **IED** in the **Substation** editor.
76

7+
<img src="https://user-images.githubusercontent.com/66802940/133250977-03eb956f-fde7-43bc-994c-790b7ec33a2a.png" alt="alt text" width="250">
88

9-
- Click on a **IED**
10-
- Click on **Add connection** button
9+
- Click on an **IED**
10+
- Click on **Add connection** button
1111
- The `ClientLN` wizard open
12-
- On the right hand side you can select the `ReportControl` element(s) in the project
12+
- On the left hand side you can select the `ReportControl` element(s) in the project
1313
- On the right hand side you can see all logical node in the receiving IED (client).
1414
- All so-called client logical nodes - logical nodes allocated to `AccessPoint` are sorted be be on top.
1515
- `LN0` element are sorted to be at the bottom
1616
- Click on `CONNECT`
1717

1818
![grafik](https://user-images.githubusercontent.com/66802940/133251594-7d552b24-e64f-4875-932a-07c990c0c7ac.png)
1919

20-
> NOTE: When `ClientLN` connections are already present in the `Report Control` block the wizard does not close in **CONNECT**
20+
> NOTE: When `ClientLN` connections are already present in the `Report Control` block the wizard does not close on **CONNECT**
2121
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.
22+
> NOTE: If the `RptEnabled` `max` attribute is smaller or equal to the `ClientLN` a connection is not possible. The `ReportControl` on the right hand side is disabled.
2323
2424
> TIP: You can filter for several terms at same time. The space between terms is acting as a logical AND.
25-

‎public/md/Communication-Basics.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
The `Communication` section in a SCL file allows to specify the network, its access points as well as the configuration of each of the access points.
2+
3+
It has as children at least one `SubNetwork`. It can be configured through the child element `BitRate`. Each `SubNetwork` can have multiple `ConnectedAP` elements, which are pointers to IEDs `AccessPoint` - attributes `iedName` and `apName`. Each `ConnectedAP` has one `Address` element and that has as many `P` elements as there are settings for this particular access point. A `P` element is structured as followed:
4+
5+
```xml
6+
<P type="IP">192.168.210.122</P>
7+
```
8+
9+
The `type` attribute defines the setting type and the inner text (here 192.168.210.122) of the element defines the setting value. There are various other optional setting types defined and OpenSCD supports to set those:
10+
11+
- IP
12+
- IP-SUBNET
13+
- IP-GATEWAY
14+
- OSI-TSEL
15+
- OSI-SSEL
16+
- OSI-PSEL
17+
- OSI-AP-Title
18+
- OSI-AP-Invoke
19+
- OSI-AE-Qualifier
20+
- OSI-AE-Invoke
21+
- OSI-NSAP
22+
- VLAN-ID
23+
- VLAN-PRIORITY
24+
- SNTP-Port
25+
- MMS-Port
26+
- DNSName
27+
- UDP-Port
28+
- TCP-Port
29+
- C37-118-IP-Port
30+
- IPv6
31+
- IPv6-SUBNET
32+
- IPv6-GATEWAY
33+
- IPv6FlowLabel
34+
- IPv6ClassOfTraffic
35+
- IPv6-IGMPv3Src
36+
- IP-IGMPv3Sr
37+
- IP-ClassOfTraffic
38+
39+
Each is backed up with pattern check against the pattern defined in the schema (2007B4).
40+
41+
A very typical `Communication` section might look like this:
42+
43+
```xml
44+
<SubNetwork type="8-MMS" name="Stationbus" desc="Subnetwork">
45+
<BitRate unit="b/s" multiplier="M">10</BitRate>
46+
<ConnectedAP iedName="AA1E1Q04MU" apName="AP1">
47+
<Address>
48+
<P type="IP">192.168.210.142</P>
49+
<P type="IP-SUBNET">255.255.255.0</P>
50+
<P type="IP-GATEWAY">192.168.210.1</P>
51+
<P type="OSI-PSEL">00000001</P>
52+
<P type="OSI-SSEL">0001</P>
53+
<P type="OSI-TSEL">0001</P>
54+
<P type="OSI-AP-Title">1,3,9999,23</P>
55+
<P type="OSI-AE-Qualifier">23</P>
56+
</Address>
57+
</ConnectedAP>
58+
<ConnectedAP iedName="AA1E1Q02BCU" apName="AP1" redProt="prp">
59+
<Address>
60+
<P type="IP">192.168.210.121</P>
61+
<P type="IP-SUBNET">255.255.255.0</P>
62+
<P type="IP-GATEWAY">192.168.210.1</P>
63+
<P type="OSI-PSEL">00000001</P>
64+
<P type="OSI-SSEL">0001</P>
65+
<P type="OSI-TSEL">0001</P>
66+
<P type="OSI-AP-Title">1,3,9999,23</P>
67+
<P type="OSI-AE-Qualifier">23</P>
68+
</Address>
69+
</ConnectedAP>
70+
</SubNetwork>
71+
```
72+
73+
> NOTE: in addition to the namespace `xmlns="http://www.iec.ch/61850/2003/SCL"` SCL files can have `xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"` as well that allows to faster parse a SCL file for communication type configuration. A `P` type element that can look like this:
74+
75+
```xml
76+
<P xsi:type="tP_IP" type="IP">192.168.210.122</P>
77+
```
78+
79+
In OpenSCD you can configure the
80+
81+
- [SubNetwork](https://github.com/openscd/open-scd/wiki/Subnetwork)
82+
- [ConnectedAP](https://github.com/openscd/open-scd/wiki/ConnectedAP)

‎public/md/Communication.md‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎public/md/Conducting-Equipment.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
**Create ConductingEquipment**
2+
3+
<img align="right" width="250" alt="grafik" src="https://user-images.githubusercontent.com/66802940/183962761-e5b168bd-94b0-4200-baaa-824e9511aa3a.png">
4+
5+
To create a new `ConductingEquipment` element within the parent `Bay`
6+
7+
- Navigate to the **Substation** editor
8+
- Select the parent **Bay** you want to add the conducting equipment to
9+
- Select the type
10+
- Fill in all required values
11+
- Click on **Add**
12+
13+
The create wizard allows to set
14+
15+
- `type`: the standard IEC 61850 defines a set of types the user can choose from
16+
- `name`: unique identified of the conducting equipment in the parent `Bay`
17+
- `desc`: human readable description
18+
19+
**Edit ConductingEquipment**
20+
21+
<img width="250" alt="grafik" src="https://user-images.githubusercontent.com/66802940/183963460-6b7e4e5a-5612-441e-bca8-6cd354f1feda.png">
22+
23+
To edit a `ConductingEquipment` element:
24+
25+
- Navigate to the **Substation** editor
26+
- Select the **ConductingEquipment** you want to edit
27+
- Click on the **edit** button
28+
- Make the changes and click **Save**
29+
30+
The element `ConductingEquipment` has two attributes
31+
32+
- `name`: unique identified of the Bay in the parent `Bay`
33+
- `desc`: human readable description
34+
- `type`: cannot be edit!
35+
36+
**Remove ConductingEquipment**
37+
38+
To remove an existing `ConductingEquipment` element within the parent `Bay`
39+
40+
- Navigate to the **Substation** editor
41+
- Select the **ConductingEquipment** you want to remove
42+
- Click on the **delete** button
43+
44+
> NOTE: OpenSCD does not support the definition of user defined conducting equipment types. This can only be manipulated through the code editor.
45+
> NOTE: The **Earth Switch** is unfortunately not a type but a special version of `DIS`. It can be tagged to a earth switch through the data object `SwType` (an logical node reference to the logical node of class `XSWI`) must be present. Or it has a child `Terminal` with a `cNodeName = grounded`. Both those cases are recognized by OpenSCD and is displayed. When you create a new **Earth Switch** the second option is applied

‎public/md/ConnectedAP.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
The element `ConnectedAP` has only two attributes and `iedName` and `apName` that in combination are a pointer to the `AccessPoint` of an `IED`. The configuration of such an `ConnectedAP` is done inside the `Address` element.
2+
3+
The structure in the **Communication** editor does not completely follow the SCL. `ConnectedAP` are grouped inside IED containers to help the user to better filter the information. When you click on such an IED container you will find that `AccessPoint`s belonging to the same IED but connected to another subnetwork are disabled but visible too.
4+
5+
<img align="right" width="250" alt="grafik" src="https://user-images.githubusercontent.com/66802940/183641520-a77cd52d-4093-42ac-a306-89322ed75b5d.png">
6+
7+
&nbsp;
8+
9+
**Create ConnectedAP**
10+
11+
As the `ConnectedAP` is just a pointer to an existing access point. The amount and the structure is limited to the amount and structure of available access points. To help the user here OpenSCD does only allow to select a `ConnectedAP` rather to create one from scratch. If an access point has already an representation in the `Communication` section you can not select it again. To create a `ConnectedAP`
12+
13+
1. Navigate to the **Communication** section
14+
2. Click in the **Add more** button of the **Subnetwork** you want to add the `ConnectedAP` element to
15+
3. Select the access point you want to connect and click **Save**
16+
17+
&nbsp;
18+
19+
**Edit ConnectedAP**
20+
21+
<img width="250" alt="grafik" src="https://user-images.githubusercontent.com/66802940/183643564-c8291c91-9d99-41ee-8de8-e34d7ebbb7b8.png">
22+
23+
To configure an `ConnectedAP` element or to be more precise its `Address` child element
24+
25+
1. Navigate to the **Communication** section
26+
2. Click in the **ConnectedAP** you want to edit
27+
3. Click on the **edit** action button
28+
29+
> NOTE: For the various types of setting please refer to IEC 61850-6. The kind of types are summarized in [Communication basics](https://github.com/openscd/open-scd/wiki/Communication-Basics)
30+
31+
&nbsp;
32+
33+
**Remove ConnectedAP**
34+
35+
To create a `ConnectedAP`
36+
37+
1. Navigate to the **Communication** section
38+
2. Click in the **ConnectedAP** you want to remove
39+
3. Click on the **delete** action button

‎public/md/Create-GOOSE-Control-Blocks.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
**Open create wizard**
2+
3+
In order to get to the GOOSE Control Block
4+
5+
1. navigate to the **Substation** editor
6+
2. click on the **G** icon button in the upper left corner
7+
3. click in **GOOSE+**
8+
4. select the `IED` you want to store the GOOSE in
9+
10+
or
11+
12+
1. navigate to the **Substation** editor
13+
2. click one of the IEDs in the editor
14+
3. click on the **G** action icon
15+
4. click in **GOOSE+**
16+
17+
> NOTE: The `GSEControl` element, its child elements and its referenced `DataSet` element are saved to the first `LN0` element in the selected `IED`.
18+
19+
&nbsp;
20+
21+
This create wizard consists of three pages. All pages need to be filled properly to be able to add the GOOSE Control Block and its DataSet to the SCL. You can navigate between the pages using the buttons in the footer.
22+
23+
> NOTE: The **Save** button that adds the GOOSE Control Block to the SCL is on the last page.
24+
25+
&nbsp;
26+
27+
**GSEControl page**
28+
29+
<img align="right" width="200" alt="grafik" src="https://user-images.githubusercontent.com/66802940/182394365-fd4198ed-1775-440d-a4e7-a6d0bc8ee4d4.png">
30+
31+
This page contains a set of settings the server needs to have to be able to generate a GOOSE:
32+
33+
- `name`: The main identifier for the GOOSE within the SCL. The name must be unique for all `GSEControl` element in the same parent element. Does influence the GOOSE Control Block reference
34+
- `desc`: optional string that is describing the `GSEControl` element
35+
- `type`: Whether this control block is a `GOOSE` or `GSSE` type. The later one is deprecated!
36+
- `appID`: a unique identifier for the GOOSE.
37+
- `fixedOffs`: Allows to specify the type of encoding for the GOOSE. For more information see IEC 61850-8-1
38+
- `securityEnabled`: The type of security measures the GOOSE has: encryption or/and signature or non of the two.
39+
40+
&nbsp;
41+
42+
<img width="300" alt="grafik" src="https://user-images.githubusercontent.com/66802940/182394792-72f37d6d-8e7b-4411-bf88-693ca6a85274.png">
43+
44+
**Communication page**
45+
46+
This page allows do define all communication related setting for the GOOSE. These information is saved to the `Communication` section.
47+
48+
1. `MAC-Address`: The destination MAC address of the GOOSE
49+
2. `APPID`: The APPID of the GOOSE. This is recommended to be unique though out the complete project.
50+
3. `VLAN-ID`: The virtual LAN ID the GOOSE shall be limited to.
51+
4. `VLAN-PRIORITY`: The priority of the GOOSE message. Can be used to priories time critical messages like trip signals over non time critical messages.
52+
5. `MinTime`: The minimum time between two occurring GOOSEs when a e.g. a trip occurs
53+
6. `MaxTime`: The maximum time between two occurring GOOSEs in case there is not trip.
54+
55+
**Data picker**
56+
57+
To define the data set a multi-select data picker is used in the last page of the create wizard. This allows you to select multiple data attributes at the same time. The exampled below picked the data attributes `general` and its quality information `q` from the data object `Op` the logical node `IP_ PTOC 1` and the logical device `ConvSS_DistProt_5051BackUpOC`.
58+
59+
![grafik](https://user-images.githubusercontent.com/66802940/182411370-0be711b6-3daa-43b1-9ec3-4d7f6eb115d0.png)
60+
61+
> NOTE: If no data is picked the `DataSet` is still created but is empty! You can add data using the edit wizard in a later stage.
62+
63+
&nbsp;

0 commit comments

Comments
 (0)