Python libraries to talk to IQ Motion Control devices
Project description
IQ Motion Python API
This library is to talk to any IQ Control devices.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Installing with Pip
You can install this library using "pip":
pip install iqmotion
Installing locally
You can also use this library by cloning this repository.
Prerequisites
RECOMMENDED: All the prerequisits can be installed with pipenv:
pipenv install
All the prerequisits can also be installed from "requirements.txt".
pip install requirements.txt
Running the tests
You will need the following packages to run the tests:
- pytest
- pytest-cov
These should be installed automatically with pipenv or requirements.txt.
But you can also install these packages with pip:
pip install pytest
pip install pytest-cov
Software tests
You can then run the software tests with the following command:
pytest ./iqmotion/tests/ --cov-config=.coveragerc --cov=iqmotion --cov-fail-under=100
The test will fail if coverage is under 100%
Hardware tests
These tests need a module connected to your computer in order to run. You can run the test for different modules.
You can run the hardware tests with the following commands:
python run_hardware_tests.py speed --usb_handle=/dev/tty/USB0
python run_hardware_tests.py servo --usb_handle=/dev/tty/USB0
python run_hardware_tests.py step_dir --usb_handle=/dev/tty/USB0
Make sure to chose the right IQ-module and the correct usb_handle for your computer.
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Here is an example on how to create a new version change before pushing
semversioner add-change --type patch --description "my_changes"
semversioner add-change --type minor --description "my_changes"
semversioner add-change --type major --description "my_changes"
After being merged into master, you can bump the version and tag by running the following bash script:
./bump_version_and_tag.sh
Authors
- Raphael Van Hoffelen
See also the list of contributors who participated in this project.
License
This project is licensed under the GPLv3 License - see the LICENSE file for details
Acknowledgments
- Matt Piccoli for helping out debugging the architecture and continuously testing the API.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for iqmotion-0.5.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78063608f32c8708a1194fc07f36c9fbec494be056817a56a102f32e941f90a2 |
|
MD5 | a06d51f0f8fa1fda5a0d2d01c261d1a2 |
|
BLAKE2b-256 | 55381dd9a294706233c6ba232ed8a7a15c8685642e4098bd3c5c309f03b15b2a |