Metadata-Version: 2.1
Name: festo-edcon
Version: 0.12.0
Summary: Library to issue profidrive tasks for Festo specific electrical drives
Author-email: Elias Rosch <elias.rosch@festo.com>
License: MIT
Project-URL: Documentation, https://festo-research.gitlab.io/electric-automation/festo-edcon
Project-URL: Repository, https://gitlab.com/festo-research/electric-automation/festo-edcon
Project-URL: Changelog, https://gitlab.com/festo-research/electric-automation/festo-edcon/-/blob/main/CHANGELOG.md
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pymodbus <4.0.0,>=3.0.0
Requires-Dist: ethernetip <2.0.0,>=1.1.1
Requires-Dist: rich
Requires-Dist: pyqt5

# festo-edcon
`festo-edcon` is a python package which bundles modules to facilitate operation of Festo electric drives (currently via EtherNet/IP and Modbus) using PROFIDRIVE. Documentation can be found [here](https://festo-research.gitlab.io/electric-automation/festo-edcon) and in the [examples](./examples) directory

## Installation
### Release
The latest release is available in the public PyPi repo. 
Install via pip:
```
pip install festo-edcon
```
### From git repo
You can also install directly from the git repo.

1. Clone the repository

```
git clone <git-url> <destination>
```

2. Change into the clone directory
```
cd <destination>
```

3. Install via pip
```
pip install .
```
## Usage
### [MotionHandler](https://festo-research.gitlab.io/electric-automation/festo-edcon/features/edrive.html#edrive-motionhandler) - [`edrive.motion.MotionHandler`](https://festo-research.gitlab.io/electric-automation/festo-edcon/edcon.edrive.html#module-edcon.edrive.motion_handler)
The motion module which aims to replicate the function set of the Siemens SinaPos function block (both using telegram 111).

### [ComModbus](https://festo-research.gitlab.io/electric-automation/festo-edcon/features/edrive.html#commodbus) - [`edrive.com_modbus.ComModbus`](https://festo-research.gitlab.io/electric-automation/festo-edcon/edcon.edrive.html#module-edcon.edrive.com_modbus)
The Modbus/TCP communication driver used for transmitting modbus traffic between host and drive.

### [ComEthernetip](https://festo-research.gitlab.io/electric-automation/festo-edcon/features/edrive.html#comethernetip) - [`edrive.com_modbus.ComEthernetip`](https://festo-research.gitlab.io/electric-automation/festo-edcon/edcon.edrive.html#module-edcon.edrive.com_ethernetip)
The EtherNet/IP communication driver used for transmitting EtherNet/IP traffic between host and drive.

### [Profidrive](https://festo-research.gitlab.io/electric-automation/festo-edcon/features/profidrive.html) - [`profidrive`](https://festo-research.gitlab.io/electric-automation/festo-edcon/edcon.profidrive.html#module-edcon.profidrive)
Contains telegram definitions that are currently supported by EDrives running PROFIDRIVE via Modbus/TCP and EtherNet/IP:
   1. Telegram 1
   2. Telegram 9
   3. Telegram 102
   4. Telegram 111

### [CLI](https://festo-research.gitlab.io/electric-automation/festo-edcon/features/cli.html) - [`cli`](https://festo-research.gitlab.io/electric-automation/festo-edcon/edcon.cli.html#module-edcon.cli)
`festo-edcon` is the main entry point to the CLI.
It supports various subcommands which execute some basic functions.

For more information use the help flag  (`festo-edcon -h`).

#### Subcommands
- `position` is a subcommand to execute very basic positioning tasks.
- `pnu` is a subcommnad to read or write PNUs.
- `parameter-set-load` is a subcommand to load a complete parameter set to a drive.
- `tg1` is a subcommnad to run a test sequence using telegram 1.
- `tg9` is a subcommnad to run a test sequence using telegram 9.
- `tg102` is a subcommnad to run a test sequence using telegram 102.
- `tg111` is a subcommnad to run a test sequence using telegram 111.



