Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 3.01 KB

README.md

File metadata and controls

73 lines (51 loc) · 3.01 KB

pyads - Python package

PyPI version Anaconda-Server Badge Anaconda-Server Badge

CI Coverage Status Documentation Status Downloads Downloads

This is a python wrapper for TwinCATs ADS library. It provides python functions for communicating with TwinCAT devices. pyads uses the C API provided by TcAdsDll.dll on Windows adslib.so on Linux. The documentation for the ADS API is available on infosys.beckhoff.com.

Documentation: http://pyads.readthedocs.io/en/latest/index.html

Issues: In order to assist with issue management, please keep the issue tracker reserved for bugs. For any questions or feature requests, please use the discussions area. Alternatively, questions can be posted to Stack Overflow tagged with twincat-ads and state you are using the pyads library. Please search around before posting questions, particulary around route creation and ads error messages when reading or writing variables as these are common issues.

Installation

From PyPi:

pip install pyads

From conda-forge:

conda install pyads

From source:

git clone https://github.com/stlehmann/pyads.git --recursive
cd pyads
python setup.py install

Features

  • connect to a remote TwinCAT device like a plc or a PC with TwinCAT
  • create routes on Linux devices and on remote plcs
  • supports TwinCAT 2 and TwinCAT 3
  • read and write values by name or address
  • read and write DUTs (structures) from the plc
  • notification callbacks

Basic usage

import pyads

# connect to plc and open connection
plc = pyads.Connection('127.0.0.1.1.1', pyads.PORT_TC3PLC1)
plc.open()

# read int value by name
i = plc.read_by_name("GVL.int_val")

# write int value by name
plc.write_by_name("GVL.int_val", i)

# close connection
plc.close()

Contributing guidelines

Contributions are very much welcome. pyads is under development. However it is a side-project so please have some patience when creating issues or PRs. Please also follow the Contributing Guidelines.