Skip to main content

IngeniaLink Communications Library

Project description

GitHub branch status PyPI Version PyPI - Python Version

CC by-nc-nd

ingenialink-python is a Python library for simple motion control tasks and communication with Ingenia drives.

Ingenia Servodrives

Requirements

  • Python 3.9 or higher

  • WinPcap 4.1.3

Installation

Installation is done by using pip, i.e:

pip install ingenialink

Documentation

For further details you can read the documentation where you will find simple usage examples, the API docs, etc.

Virtual environment management with Poetry

Install poetry:

pip install poetry

Use an environment with a certain Python version:

poetry env use 3.12

Install all dependencies:

poetry sync --all-groups --extras virtual_drive

Project Tasks - Poe The Poet plugin

To run the tasks use poe. For example, to run the format task:

poetry run poe format

Any extra CLI arguments will be appended. For example, to indicate a certain test for pytest:

poetry run poe tests -k test_servo.py

Build the module

Activate poetry environment and run the following:

poetry run poe build-wheel

Run tests

Create tests/setups/tests_setup.py file with configuration file.

This file is ignored by git and won’t be uploaded to the repository. Example of a setup:

from pathlib import Path

from summit_testing_framework.setups import LocalDriveConfigSpecifier

DEN_NET_E_SETUP = LocalDriveConfigSpecifier.from_ethercat_configuration(
   identifier="den-net-e",
   dictionary=Path("C://Users//some.user//Downloads//den-net-e_eoe_2.7.3.xdf"),
   config_file=Path("C://Users//some.user//Downloads//den_net_e.xcf"),
   firmware_file=Path("C://Users//some.user//Downloads//den-net-e_2.7.3.lfu"),
   ifname="\\Device\\NPF_{675921D7-B64A-4997-9211-D18E2A6DC96A}",
   slave=1,
   boot_in_app=False,
)

For more information, check summit-testing-framework documentation.

Run tests selecting the markers that you want and are appropriate for your setup. Beware that some tests may not be appropriate for the setup that you have and may fail.

Run the tests:

poetry run poe tests -m {markers}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ingenialink-7.6.0.tar.gz (10.7 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

ingenialink-7.6.0-py3-none-any.whl (198.0 kB view details)

Uploaded Python 3

ingenialink-7.6.0-cp312-cp312-win_amd64.whl (635.5 kB view details)

Uploaded CPython 3.12Windows x86-64

ingenialink-7.6.0-cp311-cp311-win_amd64.whl (634.2 kB view details)

Uploaded CPython 3.11Windows x86-64

ingenialink-7.6.0-cp310-cp310-win_amd64.whl (633.0 kB view details)

Uploaded CPython 3.10Windows x86-64

ingenialink-7.6.0-cp39-cp39-win_amd64.whl (633.1 kB view details)

Uploaded CPython 3.9Windows x86-64

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page