Franz Achatz / stepper

simple library for applying number of steps, direction, speed and a linear acceleration-deceleration to a Stepper Motor Controller

Dependents:   16A_Autopancakemaker

Embed: (wiki syntax)

« Back to documentation index

stepper Class Reference
Public Member Functions

stepper Class Reference

Stepper control class. More...

#include <stepper.h>

Public Member Functions

 stepper (PinName clk, PinName dir)
 Create a stepper object connected to the specified clk pin and dir pin.
void step (int n_steps, bool direction, int speed, bool accel)
 Set number of steps to direction with speed and a linear acceleration/deceleration [on/off] to a Stepper Motor Controller.
float version (void)
 get version number

Detailed Description

Stepper control class.

Example: 

 // apply number of steps, direction, speed and 
 // a linear acceleration/deceleration to a Stepper Motor Controller
 #include "mbed.h"
 #include "stepper.h"

 #define ACCEL_ON  1
 #define ACCEL_OFF 0
 #define SPEED 100
 
 stepper x(P18,P21);
 stepper y(P19,P22);
 stepper z(P20,P23);

 int main()
 {
   x.step(1000,1,SPEED,ACCEL_ON); 
   y.step(5000,0,SPEED,ACCEL_ON); 
   z.step(2000,1,SPEED,ACCEL_ON);

 }

Definition at line 53 of file stepper.h.

Constructor & Destructor Documentation

stepper ( PinName  clk,
PinName  dir 
)

Create a stepper object connected to the specified clk pin and dir pin.

Parameters:
pinclk pin to connect to
pindir pin to connect to

Definition at line 34 of file stepper.cpp.

Member Function Documentation

void step ( int  n_steps,
bool  direction,
int  speed,
bool  accel 
)

Set number of steps to direction with speed and a linear acceleration/deceleration [on/off] to a Stepper Motor Controller.

Parameters:
n_stepsnumber of steps to go
direction1 or 0
timevalue for value in us
accel1 or 0 for accel/decel [on/off]

Definition at line 38 of file stepper.cpp.

float version ( void   )

get version number

Parameters:
returnsLibrary version number

Definition at line 59 of file stepper.cpp.

Generated on Sat Jul 16 2022 15:21:55 by  doxygen 1.7.2