OpenSCD Plugin: Subscriber Later Binding - NR Electric Editor

Table of Contents

• 1. What is this?
• 2. How it works
• 3. Using the Plugin
• 4. Loading the Plugin
  • 4.1. Online Using the Latest open-scd-core
  • 4.2. Locally for testing
  • 4.3. As part of the OpenSCD distribution
  • 4.4. As part of your own distribution
• 5. Development
  • 5.1. Linting and formatting
  • 5.2. Testing with Web Test Runner
  • 5.3. Tooling configs
  • 5.4. Local Demo with web-dev-server

1. What is this?

This plugin is intended to allow a user to achieve an improvement with the later binding subscriber plugin for NR Electric devices:

• Simultaneous subscriptions of quality together with other items for GOOSE

• This is a plugin for open-scd-core, the core editor engine for OpenSCD.

• This plugin is a web component and follows the open-wc recommendations.

• This plugin uses the Apache License and is intended for you to use, study, share and improve.

Try it out online!

Feel free to log issues to request fixes, improvements or new features.

2. How it works

1. This plugin does only two things:

   • If two adjacent ExtRef elements have the same intAddr except there is a q then if in the subscribing dataset the adjacent FCDA elements are the same except the second is a quality attribute, then the quality will be automatically subscribed/unsubscribed. For example:

     <ExtRef intAddr="1-A:MUGO/GOINGGIO1.SPCSO6.stVal" serviceType="GOOSE" desc="Bay/Bus Close - 3 Pole"/>
     <ExtRef intAddr="1-A:MUGO/GOINGGIO1.SPCSO6.q" serviceType="GOOSE" desc="Bay/Bus Close - 3 Pole (Quality)"/>

3. Using the Plugin

Follow the steps in Loading the Plugin. Once the plugin is loaded:

1. The plugin provides a menu option. Go to the menu in the top left and click on the plugin name.

2. Then click enabled and then "Close".

   

3. In either the publisher or subscriber view, click on the settings icon (a cog) and check that "Allow External Plugins" is checked.

4. The plugin will automatic add or remove subscriptions as required.

4. Loading the Plugin

4.1. Online Using the Latest open-scd-core

4.1.1. Using a URL

Open SCD core allows plugins to be loaded from a URL.

You can click on this link to trial this plugin.

In this view it is without theming and only presents this plugin along with the open and save plugins.

4.1.2. Manually

1. The latest core is available at https://openscd.github.io/open-scd/.

2. Go to Menu › Add plugins…​

3. Select Cancel - this is an editor plugin.

4. Select OK to required a loaded document.

5. Choose a plugin name of 'Subscriber Later Binding - NR Electric'.

6. Choose a plugin icon of 'link'

7. Provide a plugin source URI of: https://danyill.github.io/oscd-subscriber-lb-nr/oscd-subscriber-lb-nr.js

8. Click OK on the summary, it should indicate the parameters previously entered.

9. Open a file and enjoy!

4.2. Locally for testing

1. Clone this project:

   $ git clone https://github.com/danyill/oscd-subscriber-lb-nr

2. Install dependencies

   $ npm i

3. Start up a demo server

   $ npm run start

4. Open in your browser locally at http://localhost:8000/demo/

4.3. As part of the OpenSCD distribution

Tip	OpenSCD is transitioning to use of open-scd-core, these instructions will require updating at the end of this transition.

1. Open your OpenSCD distribution or use https://openscd.github.io.

2. Create a custom extension by going to menu › Extensions › Add Custom Extension.

3. Enter the name 'Subscriber Later Binding - NR Electric', select 'Menu entry' and enter https://danyill.github.io/oscd-subscriber-lb-nr/oscd-subscriber-lb-nr.js as the URL.

   This is the URL of the bundle built by CI and is always the latest pre-release version of this plugin.

   

   Figure 1. OpenSCD Add Custom Extension Screen

4. Click on Add.

5. This plugin is now available in the menu entry.

4.4. As part of your own distribution

4.4.1. Within the current OpenSCD distribution

1. Within the current OpenSCD distribution, plugins are stored in the public/js/plugins.js folder. Each plugin appears in the following form:

   {
       name: 'Subscriber Later Binding - NR Electric', // (1)
       src: 'https://danyill.github.io/oscd-subscriber-lb-nr/oscd-subscriber-lb-nr.js', //  (2)
       icon: 'sim_card_download', // (3)
       default: true, // (4)
       kind: 'menu', // (5)
       requireDoc: true, // (6)
       position: 'middle' // (7)
     }

   1. Name of the plugin which appears in the editor menu at top of screen

   2. URL which can be a local or remote resource. For a local resource, begins without a forward slash, e.g. plugins/oscd-subscriber-lb-nr/dist/oscd-subscriber-lb-nr.js. In this case what is shown is loading a plugin from the build process.

   3. A material icon, see others at Material Symbols and Icons

   4. Whether the plugin is enabled by default or has to be enabled in the plugins menu

   5. The type of plugin, either menu or editor. This is an editor plugin.

   6. Whether a document must be loaded for this plugin to be available

   7. A string, either top, middle or bottom to give a location in the menu. Otherwise inferred from the order in the file relative to other plugins.

2. You need to copy an entry like the above, ensure the src URL resolves and the plugin should be loaded when the distribution is built.

3. If you are building locally you likely need to run an npm run bundle command in each plugin to make the dist folder, containing a single JavaScript file with the plugin available to OpenSCD.

4.4.2. Within an OpenSCD core distribution

Within an OpenSCD core distribution, plugins are also loaded from a json file with a slightly different schema.

1. Typically the distribution will be served from a static web page and within the web page there will be a plugins property declared on an open-scd object, for instance:

   link:demo/index.html[role=include]

2. This plugin is an editor plugin, editor plugins are an array of JSON of the following form:

   {
     "name": "Subscriber Later Binding - NR Electric", // (1)
     "translations": { // (2)
       "de": "Kommunikationsexport",
       "pt":"Exportação de Comunicações"
     },
     "icon": "sim_card_download", // (3)
     "active": true, // (4)
     "requireDoc": true, // (5)
     "src": "/dist/oscd-subscriber-lb-nr.js" // (6)
   }

   1. Name of the plugin which appears in the editor menu at top of screen

   2. Translations of the plugin name as required using standard locale names.

   3. A material icon, see others at Material Symbols and Icons

   4. Whether the plugin is enabled by default or has to be enabled in the plugins menu

   5. Whether a document must be loaded for this plugin to be available

   6. URL which can be a local or remote resource. For a local resource, begins with a forward slash, e.g. plugins/oscd-subscriber-lb-nr/dist/oscd-subscriber-lb-nr.js. In this case what is shown is loading a plugin from the internet using the continuous integration build process.

3. You need to copy an entry like the above, ensure the src URL resolves and the plugin should be loaded when the distribution is built.

4. If you are building locally you likely need to run an npm run bundle command in each plugin to make the dist folder, containing a single JavaScript file with the plugin available to OpenSCD.

5. Development

5.1. Linting and formatting

To scan the project for linting and formatting errors, run

npm run lint

To automatically fix linting and formatting errors, run

npm run format

5.2. Testing with Web Test Runner

To execute a single test run:

npm run test

To run the tests in interactive watch mode run:

npm run test:watch

5.3. Tooling configs

For most of the tools, the configuration is in the package.json to reduce the number of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

5.4. Local Demo with web-dev-server

To run a local development server that serves the basic demo located in demo/index.html

npm start

© 2023 Daniel Mulholland