Metadata-Version: 2.1
Name: pyldcn
Version: 0.4
Summary: Python-native implementation of LdcnLib
Author-email: Philipp Peterseil <philipp.peterseil@jku.at>
Project-URL: Homepage, https://github.com/ppeterseil/pyldcn
Project-URL: Bug Tracker, https://github.com/ppeterseil/pyldcn/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyserial (~=3.4)

# Python-native implementation of LdcnLib
This is a basic python-native implementation of LdcnLib. It implements some Ldcn and stepper methods. It solely relies on the package `pyserial`.

## Ldcn methods
The following Ldcn methods were implemented.


| Method             | Description                                     |
|--------------------|-------------------------------------------------|
| LdcnHardReset      | Resets all devices (broadcast)                  |
| LdcnSendCmd        | Send command to device                          |
| LdcnInit           | Initialize network using default group 0xFF     |
| LdcnShutdown       | Stop motor, delete devices (reinit necessary)   |
| LdcnGetDeviceId    | Returns `device, devid` for `addr`              |
| LdcnGetDevice      | Returns `device` for `addr`                     |
| LdcnGetStat        | Returns device status                           |
| LdcnGetStatItems   | Returns configured statusitems                  |
| LdcnReadStatus     | Reads local device status                       |


## Stepper methods
The following Stepper methods were implemented.


| Method             | Description                                     |
|--------------------|-------------------------------------------------|
| GetSteppers        | Returns addresses of discovered stepper devices |
| StepStopMotor      | Setup stop behaviour                            |
| StepSetParam       | Sets motor operation parameters                 |
| StepLoadTraj       | Set-up and start movement                       |
| StepResetPos       | Reset motor position to 0                       |

## Usage
To find out how the methods are used, either check LdcnLib documentation or example given in `demo.py`.

## Disclaimer
Usage at your *own risk*, the implementation is *neither complete nor well tested*.
