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.

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
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
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.

## Plugins
trusz marked this conversation as resolved.
Show resolved Hide resolved

We gather the available plugins from the community in the [plugins](docs/plugins.md) file.
trusz marked this conversation as resolved.
Show resolved Hide resolved
If you would like to list your plugin here, please open a pull request.
trusz marked this conversation as resolved.
Show resolved Hide resolved
trusz marked this conversation as resolved.
Show resolved Hide resolved

## Development

Expand Down
294 changes: 294 additions & 0 deletions docs/plugins.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,294 @@
# Plugins
trusz marked this conversation as resolved.
Show resolved Hide resolved

In this file we gather all the plugins that are available in the community.
trusz marked this conversation as resolved.
Show resolved Hide resolved
We mark our official plugins that are supported by the OpenSCD organization with a badge:
trusz marked this conversation as resolved.
Show resolved Hide resolved
<kbd>✅ Official</kbd>

> [!CAUTION]
> We do not guarantee the quality or the security of the non-official plugins
trusz marked this conversation as resolved.
Show resolved Hide resolved
trusz marked this conversation as resolved.
Show resolved Hide resolved

> [!NOTE]
> If you want to add a plugin to this list, please open a pull request.
trusz marked this conversation as resolved.
Show resolved Hide resolved

> [!TIP]
> How to add a plugin: [Extensions.md](../packages/open-scd/public/md/Extensions.md)
trusz marked this conversation as resolved.
Show resolved Hide resolved
trusz marked this conversation as resolved.
Show resolved Hide resolved

## Core Plugins
trusz marked this conversation as resolved.
Show resolved Hide resolved

Core plugins are general IEC 61850 Plugins. They can be used in any project.
trusz marked this conversation as resolved.
Show resolved Hide resolved
trusz marked this conversation as resolved.
Show resolved Hide resolved

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

These plugins are specific to a vendor.
trusz marked this conversation as resolved.
Show resolved Hide resolved

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