Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dmroeder/pylogix
Read/Write data from Allen Bradley Compact/Control Logix PLC's
https://github.com/dmroeder/pylogix
allen-bradley allen-bradley-plc cip compactlogix controllogix ethernet-ip micro8xx-plc plc pylogix python rockwell rockwell-automation
Last synced: 3 months ago
JSON representation
Read/Write data from Allen Bradley Compact/Control Logix PLC's
- Host: GitHub
- URL: https://github.com/dmroeder/pylogix
- Owner: dmroeder
- License: apache-2.0
- Created: 2016-07-22T04:16:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T21:10:10.000Z (3 months ago)
- Last Synced: 2024-08-01T23:23:40.280Z (3 months ago)
- Topics: allen-bradley, allen-bradley-plc, cip, compactlogix, controllogix, ethernet-ip, micro8xx-plc, plc, pylogix, python, rockwell, rockwell-automation
- Language: Python
- Homepage:
- Size: 1.35 MB
- Stars: 565
- Watchers: 72
- Forks: 182
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: docs/Contributing.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# pylogix
[](https://discord.gg/tw8E9EAAnf)
**WARNING**: There is a possibility of a scam using the pylogix name. Be careful with anything claiming to be pylogix. https://www.notpylogix.com
Pylogix is a communication driver that lets you easily read/write values from tags in Rockwell Automation ControlLogix, CompactLogix, and Micro8xx PLCs over Ethernet I/P using Python. Only PLCs that are programmed with RSLogix5000/Studio5000 or Connected Components Workbench (Micro8xx), models like PLC5, SLC, and MicroLogix are *not* supported. They use a different protocol, which I have no plans to support. You can also connect to RSEmulate, but it may require additional
configuration. See the Emulate [document](https://github.com/dmroeder/pylogix/blob/master/docs/Emulate.md) for more information.
Many devices support CIP objects that allow for automatic discovery (like RSLinx does), which pylogix can discover but will likely not be able to interact with in any other meaningful way. Pylogix is only intended to talk to the above-mentioned PLCs and is only tested against them. It likely will not communicate with any other brands.
For general support or questions, I created a [discord](https://discord.gg/tw8E9EAAnf). Feel free to join and ask questions, and I'll do my best to help promptly.
## Getting Started
There are no dependencies, so you can get going quickly without installing other prerequisite packages. Both python2 and python3 are supported.
### Installing
Install pylogix with pip (Latest version):
```console
pylogix@pylogix-kde:~$ pip install pylogix
```
To install previous version before major changes (0.3.7):
```console
pylogix@pylogix-kde:~$ pip install pylogix==0.3.7
```
To upgrade to the latest version:
```console
pylogix@pylogix-kde:~$ pip install pylogix --upgrade
```
Alternatively, you can clone the repo and manually install it:
```console
pylogix@pylogix-kde:~$ git clone https://github.com/dmroeder/pylogix.git
pylogix@pylogix-kde:~$ cd pylogix
pylogix@pylogix-kde:~/pylogix$ python setup.py install --user
```
### Verifying Installation
To verify the installation on Linux, open the terminal and use the following commands:
```console
pylogix@pylogix-kde:~$ python3
Python 3.8.5 (default, Jan 27 2021, 15:41:15)
[GCC 9.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import pylogix
>>> pylogix.__version__
'0.7.10'
```
### Your First Script:
The cloned repository will come with many examples, I'll give one here. We'll read one simple tag and print out the value. All methods will return the Response class, which contains TagName, Value and Status.
```python
from pylogix import PLC
with PLC() as comm:
comm.IPAddress = '192.168.1.9'
ret = comm.Read('MyTagName')
print(ret.TagName, ret.Value, ret.Status)
```
NOTE: If your PLC is in a slot other than zero (like can be done with ControLogix), then you can specify the slot with the following:
```
comm.ProcessorSlot = 2
```
NOTE: If you are working with a Micro8xx PLC, you must set the Micro800 flag since the path is different:
```
comm.Micro800 = True
```
Optionally set a specific maximum size for requests/replies. If not specified, defaults to try a Large, then a Small Forward Open (for Implicit, "Connected" sessions).
```
comm.ConnectionSize = 508
```
## Installing MicroPython
Checkout [Documentation](https://github.com/dmroeder/pylogix/blob/master/docs/mpy/README.md)
### Other Features
Pylogix has features other than simply reading/writing. See the [documentation](https://github.com/dmroeder/pylogix/blob/master/docs/Documentation.md) for more info, see the examples directory
simple use cases for the various methods.
## FAQ
Here's a list of frequent asked questions. [faq](https://github.com/dmroeder/pylogix/blob/master/docs/FAQ.md)
## Authors
* **Burt Peterson** - *Initial work*
* **Dustin Roeder** - *Maintainer* - [dmroeder](https://github.com/dmroeder)
* **Fernando B. (TheFern2)** - *Contributor* - [TheFern2](https://github.com/TheFern2)
* **Joe Ryan** - *Contributor* - [jryan](https://bitbucket.org/jryan/aphytcomm/src/master/)
* **Perry Kundert** - *Contributor* - [pjkundert](https://github.com/pjkundert)
## License
This project is licensed under Apache 2.0 License - see the [LICENSE](https://github.com/dmroeder/pylogix/blob/master/LICENSE.txt) file for details.
## Acknowledgments
* Archie of AdvancedHMI for all kinds pointers and suggestions.
* Thanks to ottowayi for general python and good practice advice.
* Thanks to all of the users that have tested and provided feedback.
* Joe Ryan for Omron testing and feedback