OpenSCD API for IEC 61850 SCL files
npm install @openscd/oscd-api !NPM Version
This package defines a common set of APIs, types, and interfaces for use by OpenSCD distributions and plugins.
It does not contain any business logic or implementation—only the shared contracts that enable interoperability between OpenSCD core, plugins, and distribution builders.
- For Plugin Developers:
Provides the types and event interfaces needed to build plugins that integrate seamlessly with OpenSCD core.
See docs/plugin-api.md for a detailed description of the plugin API.
- For Distribution Builders:
Supplies the types and interfaces for the OpenSCD root element and other extension points.
_API documentation for the OpenSCD root element and constraints for plugin.json will be provided in future docs._
- Plugin API:
Comprehensive guide for plugin authors, including property contracts, event types, and theming.
- _Additional documentation (e.g., for the OpenSCD root element and plugin.json constraints) will be added soon._