Repository for uStepper
C++ Assembly
Clone or download
Latest commit b24c751 Jun 3, 2018

README.md

uStepper

The library contains support for driving the stepper, measuring temperature and reading out encoder data. Two examples are included to show the functionality of the library. The library is supported in Arduino IDE 1.6.7, 1.6.8, 1.6.9, 1.6.10, 1.6.11, 1.6.12, 1.8.3.

For more information, visit www.ustepper.com

News!

This version of the library adds two new functions to the library:

moveToAngle() - This makes it possible to specify a desired angle to reach, with respect to the last reset of home position MoveAngle() - This makes it posible to move the motor an angle relative to its current position, without having to calculate the steps required, and manually call moveSteps();

For more information about the use of these functions, see the documentation page.

Closed loop is now implemented !

We have (for quite some time now) been working on closed loop control of the uStepper motors, and we have finally made it work ! Two modes of control has been implemented. The first mode is the drop-in feature, which takes in step/dir/enable pulses from a 3d printer/cnc controller, and moves the motor based on these pulses, correcting for any missed steps in the process. The second mode is for regular movement functions, such as "moveSteps()", and works just as it have always worked, with the addition of correcting, should any steps be missed. We have supplied some standard PID parameters, however these parameters will most likely need to be custom tuned to your specific application. The parameters provided works well with our Prusa I3 3d printer, but it will vary greatly between different setups !

Documentation

Documentation for the uStepper library can be found at the following URL: http://ustepper.com/docs/html/index.html

To add hardware support for uStepper in the Arduino IDE (1.6.xx) do the following:

You have now added uStepper hardware support and should be able to select uStepper under tools -> boards.

To add the uStepper library do the following:

  • Go to Sketch->Include Libraries->Manage Libraries... in the arduino IDE
  • Search for "uStepper", in the top right corner of the "Library Manager" window
  • Install uStepper library

MAC users should be aware, that OSX does NOT include FTDI VCP drivers, needed to upload sketches to the uStepper, by default. This driver should be downloaded and installed from FTDI's website:

http://www.ftdichip.com/Drivers/VCP.htm

The uStepper should NOT be connected to the USB port while installing this driver ! This is not a problem for windows/linux users, as these drivers come with the arduino installation.

Change Log

1.3.0:

  • Changed MoveToAngle() function, to support update of angle setpoint in PID mode
  • Changed getMotorState() function, to support update of angle setpoint in PID mode
  • Fixed bug in moveAngle() function, where negative inputs had no effect
  • Changed the "LimitDetection" example to make use of the new moveToEnd() function

1.2.3:

  • Added moveAngle() and MoveToAngle() functions
  • Minor adjustments in setup routines

1.2.2:

  • Adjusted parameters in limitDetection example, and dropin example
  • Added setCurrent() function to the uStepper object, for the user to easily change current setting
  • Minor corrections in PID algorithms

1.2.1:

  • Fixed a bug in the implementation of the standalone PID controller, primarily anti windup
  • Added example to show how limit detection can be implemented without the use of limit switches
  • Adjusted encoder.setHome() function to also reset the stepsSinceReset variable

1.2.0:

  • Adjusted the code related to the PID closed loop position control. Now it actually works as intended!
  • Fixed Bug with encoder.getStrength and encoder.getAgc functions not reading the correct registers in the encoder
  • Changed getStepsSinceReset() to return a 32 bit signed integer, instead of a 64 bit signed integer, which is just overkill, and doesn't really play well with arduino
  • Changed some minor things in the assembly code to optimise stuff with regards to the PID mode
  • Fixed a bug in the assembly code causing the StepsSinceReset variable to always decrease regardless of the direction of rotation. This resulted in the number of steps moved since reset, always being negative
  • Fixed a typo in the documentation of the getCurrentDirection() function, to state the correct return values
  • Added several keywords to the library
  • Added Example to demonstrate the use of PID closed loop position control

1.1.0:

  • Fixed bug with encoder.setHome() function, where number of revolutions was never reset, resulting in the angle being reset to the number of revolutions times 360 degrees, instead of 0 degrees
  • Implemented Timeout in I2C functions. This ensures that the program will not lock up if access to a non-existing I2C address is attempted.
  • Added overloaded function to pwmD8() and pwmD3(), in order to be able to revert the function of these to pins, back to normal IO mode

1.0.0:

  • Added PID functionality to drop-in Feature
  • Added PID functionality to regular movement functions
  • Added support for servo motors
  • Added one new example
  • Revised Drop-in example to utilise PID controller

0.4.5:

  • Changed setup of Timer1 and Timer2, to allow for PWM generation on D3 and D8. See documentation of "pwmD3()" and "pwmD8()" functions in class "uStepper", for instructions.
  • Changed setup of external interrupts for dropin feature, to be able to compile with arduino IDE 1.6.10.
  • Updated board installation package to version 1.1.0, to be compliant with arduino IDE 1.6.10. Update uStepper board using package manager in Arduino IDE ("Tools->Board->Board Manager", scroll down to the uStepper board and choose update or install).

0.4.4:

  • Added the attribute "used" to declarations of interrupt routines. This enables the library to be compiled in Arduino IDE 1.6.10
  • Updated documentation of "uStepper::setup()"

0.4.3:

  • Fixed bug where initial deceleration phase (used when changing speed setting or changing direction while motor is moving), would never be entered, causing motor to accelerate

0.4.2:

  • Fixed bug with setHome() causing getAngleMoved() to return alternating values (offset by exactly 180 degrees) between resets.
  • Fixed bug in runContinous(), where direction of the motor did not get updated if the function was called with the motor standing still.

0.4.1:

  • Fixed bug with getAngleMoved() returning alternating values (offset by exactly 180 degrees) between resets.
  • Added keywords
  • Updated pin connection description for Drop-in example

0.4.0:

  • Added Drop-in feature to replace stepsticks with uStepper for error correction
  • Fixed bug in stepper acceleration algorithm, making the motor spin extremely slow at certain accelerations. Also this fix reduced the motor resonance
  • Implemented an IIR filter on the speed measurement, to smooth this out a bit.

0.3.0:

  • Added support for speed readout
  • Added support for measuring the shaft position with respect to a zero reference. (absolute within multiple revolutions)

0.2.0:

  • Complete rewrite of the stepper algorithm in assembler
  • Changed from fixed point to floating point variables, due to the need for more precision
  • Removed the getSpeed() method, as it didn't work, and therefore it would make more sense to remove it and re-add it when i get the time to fix it
  • Added a few doxygen comments
  • Added a new method (getStepsSinceReset()), which returns all steps performed since reset of the uStepper. positive values corresponds to steps in clockwise direction, while negative values corresponds to steps in counterclockwise direction.

0.1.0:

  • Initial release

Creative Commons License
uStepper by ON Development is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.