- Table of contents
- Overview
- Installation
- Files
- Dependencies
- Components
- Software matrix
- Notes and Issues
- Name: RpiMotorLib
- Title: Raspberry pi motor library.
- Description:
A python 3 library for various motor controllers and servos to connect to a raspberry pi. These components are some of the most widely used by community. There are three categories in library. Stepper motors, DC Motors and Servos. The end user can import this library into their projects and then control the components with short snippets of code. The library is modular so user can just import/use the section they need.
- Main Author: Gavin Lyons , website..
- Project URL: URL LINK
- History: CHANGELOG.md is at repository in documentation.
- Copyright: See LICENSE.md
- Pull requests,bug reports, suggestions for new components and features welcome.
The library was tested and built on a raspberry pi 3 model b, It was also tested for Python (3.5.3) and Raspbian stretch 9.
Rpimotorlib is in the PYPI Link The Python Package Index (PyPI) is a repository of software for the Python programming language.
Make sure that python3 and pip3 have been installed on your machine, then:
sudo pip3 install rpimotorlibrpiMotorLib files are listed below:
| File Path | Description |
|---|---|
| RPiMotorLib/RpiMotorLib.py | stepper motor python library file |
| RPiMotorLib/rpiservolib.py | servo python library RPi.GPIO PWM file |
| RPiMotorLib/rpi_pservo_lib.py | servo python library pigpio PWM file |
| RPiMotorLib/rpi_dc_lib.py | DC python motor library file |
| documentation/*.md | 15 markdown library documentation files |
| test/*Test.py | 14 python test files |
| /usr/share/doc/RpiMotorLib/README.md | This help file |
| RPiMotorLib/RpiMotorScriptLib.py | small script with meta data about library |
A small script is installed to display version and help information. Run the information script by typing. RpiMotorScriptLib.py -[options]
| Option | Description |
|---|---|
| -h | Print help information and exit |
| -v | Print version information and exit |
- RPi.GPIO 0.6.3 Rpi.GPIO pypi page
A module to control Raspberry Pi GPIO channels. This package provides a class to control the GPIO on a Raspberry Pi. This should already be installed on most Raspberry Pis.
- pigpio 1.64-1 Homepage
This Dependency is Optional, it is currently only used in one of the two servo control options. pigpio is a library for the Raspberry which allows control of the General Purpose Input Outputs (GPIO).
Şeparate help files are in documentation folder to learn how to use library. Click on the relevant URL link in tables below. Test files used during development are in test folder of repo. There is a software matrix section below which shows which class is used for which controller, or consult the docstring of the appropriate python file.
- Stepper motors
| Motor tested | Motor controller | Help File URL link |
|---|---|---|
| Unipolar 28BYJ-48 | ULN2003 driver module | URL |
| Bipolar Nema | TB6612FNG Dual Driver Carrier | URL |
| Bipolar Nema | L298N H-Bridge controller module | URL |
| Bipolar Nema | A4988 Stepper Driver Carrier | URL |
| Bipolar Nema | DRV8825 Stepper Driver Carrier | URL |
| Bipolar Nema | A3967 Stepper Driver aka "easy driver v4.4" | URL |
| Bipolar (untested on hw) | LV8729 Stepper Driver Carrier | URL |
| Bipolar (untested) | DV8833 Motor controller module | WIP |
| Bipolar (untested) | L9110S Motor controller module | WIP |
- DC motors
| Motor | Motor controller | Help File URL link |
|---|---|---|
| DC Brushed Motor | L298N Motor controller module. | URL |
| DC Brushed Motor | L9110S Motor controller module. | URL |
| DC Brushed Motor | DV8833 Motor controller module. | URL |
| DC Brushed Motor | TB6612FNG Dual Motor Driver Carrier | URL |
| DC Brushed Motor | Transistor control | URL |
- Servos (two different options see Note 3 below)
| Servo | Link |
|---|---|
| Servo software timing | RPi.GPIO module PWM |
| Servo hardware timing | pigpio library module PWM |
Software matrix showing which classes are used to drive which components.
| Controller/Motor | DC motor | Stepper Nema bipolar | Stepper 28BYJ Unipolar 5 |
|---|---|---|---|
| transistor | TranDc | n/a | n/a |
| l298 | L298NMDc | BYJMotor | n/a |
| ULN2003 | n/a | n/a | BYJMotor |
| a4988 | n/a | A4988Nema | n/a |
| a3967 | n/a | A3967EasyNema | n/a |
| Drv8825 | n/a | A4988Nema | n/a |
| L9110S | DRV8833 | BYJMotor? WIP | n/a |
| Drv8833 | DRV8833 | BYJMotor? WIP | n/a |
| TB6612FNG | TB6612FNGDc | BYJMotor | n/a |
| LV8729 | n/a | A4988Nema | n/a |
Note 1 Running two motors simultaneously
See github issue #11
If you want to control two steppers simultaneously, there are two basic setup file for using threading in test folder.
- For Unipolar 28BYJ-48 MultiMotorThreading_BYJ.py
- For Bipolar DRV8825 Stepper MultiMotorThreading_DRV8825.py
Note 2 Potential Issue with GPIO.cleanup() not working
See github issue #18 and #21
Some users are reporting that GPIO.cleanup() does not work. It does not switch off or "cleanup" GPIO as it should. This is external function from RPi.GPIO. It is mainly used in the test scripts. It is also called by the classes in DC motor if the cleanup method is passed argument "true". If you see this issue simply don't use GPIO.cleanup() or remove GPIO.cleanup and clear the GPIO you set manually or use python "del" method to destroy the relevant class object, to free resources if you need them again.
Note 3 Servo options
There are two different options for controlling the servo. When using Rpi_GPIO option you may notice twitching at certain delays and stepsizes. This is the result of the implementation of the RPIO PWM software timing. If the application requires precise control the user can pick the pigpio library which uses hardware based timing. The disadvantage being they must install a dependency.