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

doc: document all available plug-ins #1436

Merged
merged 20 commits into from
Mar 11, 2024
Merged

doc: document all available plug-ins #1436

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
135d29a
doc: setup plugin collection
Feb 7, 2024
3c92840
doc: different style
Feb 7, 2024
f9e9bd4
doc: correct explanation
Feb 7, 2024
9bad8d8
doc add plugins
Feb 7, 2024
a5a6122
doc: fix badge and remove localhosts
Feb 7, 2024
8590f45
doc: add sprinteins plugins
Feb 7, 2024
2ce46f3
doc: different categories and tags
Feb 9, 2024
6beeb14
doc: add category to plugins
Feb 9, 2024
63e7d70
doc: add reference to readme
Feb 9, 2024
9c47316
doc: reference how to add plugins
Feb 9, 2024
8fd980b
ref: rename file to make it consistent
Feb 21, 2024
2971d47
ref: make text consistent
Feb 21, 2024
221cd23
fix: consistent wording
Feb 21, 2024
d731a32
fix: wording
Feb 21, 2024
b8b4f46
fix: wording of plug-in
Feb 21, 2024
2acfa6f
Merge branch 'main' into doc/plugins
Feb 22, 2024
e8e0c66
Merge branch 'main' into doc/plugins
juancho0202 Feb 26, 2024
5ab5315
doc(plug-ins): clarify description a bit more
Mar 7, 2024
7cd60df
Merge branch 'doc/plugins' of github.com:trusz/open-scd into doc/plugins
Mar 7, 2024
170ffd3
Merge branch 'main' into doc/plugins
pascalwilbrink Mar 8, 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
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ In order to install your own instance of OpenSCD on your own webserver (e.g. on

If you don't have your own webserver but still want your own version of OpenSCD hosted locally (e.g. on a system without an internet connection), you can [use a browser plugin that acts as a local webserver](https://github.com/openscd/open-scd/wiki/Install-OpenSCD#offline) (only for you) instead.

## Plug-ins

We gather the available plug-ins from the community in the [plug-ins](docs/plug-ins.md) file.
If you would like to list your plug-in here, please open a pull request.

## Development

Expand Down
294 changes: 294 additions & 0 deletions docs/plug-ins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
# Plug-ins

In this file we gather all the plug-ins that are available in the community.
We mark our official plug-ins that are supported by the OpenSCD organization with a badge:
<kbd>✅ Official</kbd>

> [!CAUTION]
> We have no control over the quality or security of unofficial plug-ins.

> [!NOTE]
> If you want to add a plug-in to this list, please open a pull request.

> [!TIP]
> How to install a plug-in: [Extensions.md](../packages/open-scd/public/md/Extensions.md)

## Core Plug-ins

Core plug-ins are general IEC 61850 plug-ins. They can be used in any project.

### IED

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/IED.js
> ```

### Substation

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/Substation.js
> ```

### Single Line Diagram

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/SingleLineDiagram.js
> ```

### Subscriber Message Binding (GOOSE)

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/GooseSubscriberMessageBinding.js
> ```

### Subscriber Data Binding (GOOSE)

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/GooseSubscriberDataBinding.js
> ```

### Subscriber Later Binding (GOOSE)

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/GooseSubscriberLaterBinding.js
> ```

### Subscriber Message Binding (SMV)

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/SMVSubscriberMessageBinding.js
> ```

### Subscriber Data Binding (SMV)

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/SMVSubscriberDataBinding.js
> ```

### Subscriber Later Binding (SMV)

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/SMVSubscriberLaterBinding.js
> ```

### Communication

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/Communication.js
> ```

### 104

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/Protocol104.js
> ```

### Templates

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/Templates.js
> ```

### Publisher

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/Publisher.js
> ```

### Cleanup

> <kbd>✅ Official</kbd> | <kbd>Editor</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/editors/Cleanup.js
> ```

### Open project

> <kbd>✅ Official</kbd> | <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/OpenProject.js
> ```

### New project

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/NewProject.js
> ```

### Save project

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/SaveProject.js
> ```

### Validate Schema

> <kbd>✅ Official</kbd> | <kbd>Validator</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/validators/ValidateSchema.js
> ```

### Validate Templates

> <kbd>✅ Official</kbd> | <kbd>Validator</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/validators/ValidateTemplates.js
> ```

### Import IEDs

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/ImportIEDs.js
> ```

### Create Virtual IED

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/VirtualTemplateIED.js
> ```

### Subscriber Update

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/SubscriberInfo.js
> ```

### Merge Project

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/Merge.js
> ```

### Update Substation

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/UpdateSubstation.js
> ```

### Compare IED

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/CompareIED.js
> ```

### Export Communication Section

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/ExportCommunication.js
> ```

### Help

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/Help.js
> ```

### Show SCL History

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/SclHistory.js
> ```

### Communication Explorer

> <kbd>Editor</kbd> | by [SprintEins](https://github.com/sprinteins) | [Repository](https://github.com/sprinteins/oscd-plugins)
>
> ```
> https://sprinteins.github.io/oscd-plugins/communication-explorer/index.js
> ```

### Network Explorer

> <kbd>Editor</kbd> | by [SprintEins](https://github.com/sprinteins) | [Repository](https://github.com/sprinteins/oscd-plugins)
>
> ```
> https://sprinteins.github.io/oscd-plugins/network-explorer/index.js
> ```

### Type Switcher

> <kbd>Editor</kbd> | by [SprintEins](https://github.com/sprinteins) | [Repository](https://github.com/sprinteins/oscd-plugins)
>
> ```
> https://sprinteins.github.io/oscd-plugins/type-switcher/index.js
> ```

### Documentation

> <kbd>Editor</kbd> | by [SprintEins](https://github.com/sprinteins) | [Repository](https://github.com/sprinteins/oscd-plugins)
>
> ```
> https://sprinteins.github.io/oscd-plugins/documentation/index.js
> ```

## Vendor Specific Plug-ins

These plug-ins are specific to a vendor.

### Update desc (ABB)

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/UpdateDescriptionABB.js
> ```

### Update desc (SEL)

> <kbd>✅ Official</kbd> | <kbd>Menu</kbd> | by [OpenSCD](https://github.com/openscd) | [Repository](https://github.com/openscd/open-scd/)
>
> ```
> https://openscd.github.io/src/menu/UpdateDescriptionSEL.js
> ```
Loading