Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 4.73 KB

README.md

File metadata and controls

91 lines (65 loc) · 4.73 KB
Raw

SELProtoPy logo

Schweitzer Engineering Laboratories (SEL) Protocol Bindings in Python

PyPI Version Downloads Stars License

pydocstyle pylint

GitHub Pages (development documentation): https://engineerjoe440.github.io/selprotopy/

ReadTheDocs (production documentation): https://selprotopy.readthedocs.io/

This project is still in early stages, much is still to come.

Description

selprotopy is intended to be used as a protocol binding suite for the SEL Protocol suite which includes SEL Fast Meter, SEL Fast Message, and SEL Fast Operate; each of which are proprietary protocols designed by Schweitzer Engineering Laboratories for use primarily with protective electric relays, and other intelligent electronic devices.

⚠️ Caution

This project, although binding SEL Protocol, is not sponsored, tested, or vetted in any way by Schweitzer Engineering Laboratories (SEL). This project is authored and maintained as an open-source project. Testing is performed on a very small set of hardware running in the author's basement. In short, this project has no association with SEL.

Since this project is not rigorously tested across all SEL devices or in a wide variety of use-cases, any time this project is used, it should first be thoroughly tested. This project is not intended to serve protection-class systems in any capacity. It should primarily be used for research, exploration, and other learning objectives.

📚 Protocol Documentation

SEL Protocol was introduced in the early 1990s to support various communications and control of SEL protective relays. SEL provided a very supportive application guide which provides great detail about the protocol's implementation. This application guide is a great resource and thoroughly documents the core framework of SEL Protocol. This guide is the basis of the bindings provided here. The guide can be accessed with a free account on the SEL website:

Installation

From PyPI as a Python Package

Just go ahead and issue: pip install selprotopy

From Source on Github

To install selprotopy from GitHub:

  1. Download the repository as a zipped package.
  2. Unzip the repository.
  3. Open a terminal (command-prompt) and navigate to the new folder that's been unzipped. (Hint: Use cd <the-path-to-the-folder-you-unzipped-in>/selprotopy)
  4. Use pip or python to install with the following commands, respectively:
    • $> pip install .
    • $> python setup.py install
  5. Verify that it's been installed by opening a Python instance and importing: >>> import selprotopy If no errors arise, the package has been installed.

Contributing

Want to get involved? We'd love to have your help!

Please help us by identifying any issues that you come across. If you find an error, bug, or just have questions, jump over to the issue page.

If you want to add features, or contribute yourself, feel free to open a pull-request.

Contact Info

ℹ️ As mentioned in the caution above, this project is not associated with Schweitzer Engineering Laboratories (SEL) in any way, and as such, all contacts for questions, support, or other items should be directed to the resources listed here.

For issues found in the source code itself, please feel free to open an issue, but for general inquiries and other contact, feel free to address Joe Stanley, the project maintainer.