#include <avr/io.h>#include <avr/interrupt.h>#include <Arduino.h>#include <EEPROM.h>#include <inttypes.h>#include <uStepperServo.h>#include <uStepperEncoder.h>#include <uStepperDriver.h>
Go to the source code of this file.
Classes | |
| union | floatBytes_t |
| Union to easily split a float into its binary representation. More... | |
| struct | dropinCliSettings_t |
| Struct to store dropin settings. More... | |
| struct | posFilter_t |
| Struct for encoder velocity estimator. More... | |
| class | uStepperS |
| Prototype of class for accessing all features of the uStepper S in a single object. More... | |
Macros | |
| #define | FREEWHEELBRAKE 0 |
| #define | COOLBRAKE 1 |
| #define | HARDBRAKE 2 |
| #define | CW 1 |
| #define | CCW 0 |
| #define | POSITION_REACHED 0x20 |
| #define | VELOCITY_REACHED 0x10 |
| #define | STANDSTILL 0x08 |
| #define | STALLGUARD2 0x04 |
| #define | HARD 0 |
| #define | SOFT 1 |
| #define | DRV_ENN PD4 |
| #define | SD_MODE PD5 |
| #define | SPI_MODE PD6 |
| #define | CS_DRIVER PE2 |
| #define | CS_ENCODER PD7 |
| #define | MOSI1 PE3 |
| #define | MOSI_ENC PC2 |
| #define | MISO1 PC0 |
| #define | SCK1 PC1 |
| #define | NORMAL 0 |
| #define | DROPIN 1 |
| #define | CLOSEDLOOP 2 |
| #define | PID CLOSEDLOOP |
| #define | CLOCKFREQ 16000000.0 |
| #define | ENCODERINTFREQ 1000 |
| #define | ENCODERINTPERIOD 1.0/ENCODERINTFREQ |
| #define | PULSEFILTERKP 120.0 |
| #define | PULSEFILTERKI 1900.0*ENCODERINTPERIOD |
Functions | |
| void | TIMER1_COMPA_vect (void) __attribute__((signal |
| Interrupt routine for critical tasks. More... | |
| void | interrupt0 (void) |
| Used by dropin feature to take in step pulses. More... | |
| void | interrupt1 (void) |
| Used by dropin feature to take in enable signal. More... | |
Variables | |
| void | used |
Macro Definition Documentation
◆ CCW
| #define CCW 0 |
Define label users can use as argument for runContinous() function to specify counterclockwise direction
Definition at line 160 of file uStepperS.h.
◆ CLOCKFREQ
| #define CLOCKFREQ 16000000.0 |
MCU Clock frequency
Definition at line 235 of file uStepperS.h.
◆ CLOSEDLOOP
| #define CLOSEDLOOP 2 |
Value defining closed loop mode for normal library functions
Definition at line 232 of file uStepperS.h.
◆ COOLBRAKE
| #define COOLBRAKE 1 |
Define label users can use as argument for setBrakeMode() function to make the motor brake by shorting the two bottom FET's of the H-Bridge. This will provide less holding torque, but will significantly reduce driver heat
Definition at line 156 of file uStepperS.h.
◆ CS_DRIVER
| #define CS_DRIVER PE2 |
Define label for driver chip select pin. Not normally needed for users
Definition at line 221 of file uStepperS.h.
◆ CS_ENCODER
| #define CS_ENCODER PD7 |
Define label for encoder chip select pin. Not normally needed for users
Definition at line 222 of file uStepperS.h.
◆ CW
| #define CW 1 |
Define label users can use as argument for runContinous() function to specify clockwise direction
Definition at line 159 of file uStepperS.h.
◆ DROPIN
| #define DROPIN 1 |
Value defining dropin mode for 3d printer/CNC controller boards
Definition at line 231 of file uStepperS.h.
◆ DRV_ENN
| #define DRV_ENN PD4 |
Define label for driver DRV_ENN pin. Not normally needed for users
Definition at line 217 of file uStepperS.h.
◆ ENCODERINTFREQ
| #define ENCODERINTFREQ 1000 |
Frequency at which the encoder is sampled, for keeping track of angle moved and current speed Frequency is 1kHz in dropin and 2kHz for all other modes. base define is 1kHz, and if the mode is not dropin, it is multiplied by 2 in the relevant places of the code
Definition at line 241 of file uStepperS.h.
◆ ENCODERINTPERIOD
| #define ENCODERINTPERIOD 1.0/ENCODERINTFREQ |
Frequency at which the encoder is sampled, for keeping track of angle moved and current speed
Definition at line 242 of file uStepperS.h.
◆ FREEWHEELBRAKE
| #define FREEWHEELBRAKE 0 |
Define label users can use as argument for setBrakeMode() function to specify freewheeling as brake mode. This will result in no holding torque at standstill
Definition at line 155 of file uStepperS.h.
◆ HARD
| #define HARD 0 |
Define label users can use as argument for stop() function to specify that the motor should stop immediately (without decelerating)
Definition at line 214 of file uStepperS.h.
◆ HARDBRAKE
| #define HARDBRAKE 2 |
Define label users can use as argument for setBrakeMode() function to use full specified current for braking. This will provide high holding torque, but will make the driver (and motor) dissipate power
Definition at line 157 of file uStepperS.h.
◆ MISO1
| #define MISO1 PC0 |
Define label for driver chip MISO pin. Not normally needed for users
Definition at line 226 of file uStepperS.h.
◆ MOSI1
| #define MOSI1 PE3 |
Define label for driver chip MOSI pin. Not normally needed for users
Definition at line 224 of file uStepperS.h.
◆ MOSI_ENC
| #define MOSI_ENC PC2 |
Define label for encoder chip MOSI pin. Not normally needed for users
Definition at line 225 of file uStepperS.h.
◆ NORMAL
| #define NORMAL 0 |
Value defining normal mode
Definition at line 230 of file uStepperS.h.
◆ PID
| #define PID CLOSEDLOOP |
Value defining PID mode for normal library functions. only here for backwards compatibility
Definition at line 233 of file uStepperS.h.
◆ POSITION_REACHED
| #define POSITION_REACHED 0x20 |
Define label users can use as argument for getMotorState() function to check if target position has been reached
Definition at line 162 of file uStepperS.h.
◆ PULSEFILTERKI
| #define PULSEFILTERKI 1900.0*ENCODERINTPERIOD |
I term in the PI filter estimating the step rate of incomming pulsetrain in DROPIN mode
Definition at line 244 of file uStepperS.h.
◆ PULSEFILTERKP
| #define PULSEFILTERKP 120.0 |
P term in the PI filter estimating the step rate of incomming pulsetrain in DROPIN mode
Definition at line 243 of file uStepperS.h.
◆ SCK1
| #define SCK1 PC1 |
Define label for driver chip SCK pin. Not normally needed for users
Definition at line 227 of file uStepperS.h.
◆ SD_MODE
| #define SD_MODE PD5 |
Define label for driver chip SD_MODE pin. Not normally needed for users
Definition at line 218 of file uStepperS.h.
◆ SOFT
| #define SOFT 1 |
Define label users can use as argument for stop() function to specify that the motor should decelerate before stopping
Definition at line 215 of file uStepperS.h.
◆ SPI_MODE
| #define SPI_MODE PD6 |
Define label for driver SPI_MODE pin. Not normally needed for users
Definition at line 219 of file uStepperS.h.
◆ STALLGUARD2
| #define STALLGUARD2 0x04 |
Define label users can use as argument for getMotorState() function to check stallguard status
Definition at line 165 of file uStepperS.h.
◆ STANDSTILL
| #define STANDSTILL 0x08 |
Define label users can use as argument for getMotorState() function to check if motor is not currently running
Definition at line 164 of file uStepperS.h.
◆ VELOCITY_REACHED
| #define VELOCITY_REACHED 0x10 |
Define label users can use as argument for getMotorState() function to check if target velocity has been reached
Definition at line 163 of file uStepperS.h.
Function Documentation
◆ interrupt0()
| void interrupt0 | ( | void | ) |
Used by dropin feature to take in step pulses.
This interrupt routine is used by the dropin feature to keep
track of step and direction pulses from main controller
Definition at line 544 of file uStepperS.cpp.
◆ interrupt1()
| void interrupt1 | ( | void | ) |
Used by dropin feature to take in enable signal.
This interrupt routine is used by the dropin feature to keep
track of enable signal from main controller
Definition at line 532 of file uStepperS.cpp.
◆ TIMER1_COMPA_vect()
| void TIMER1_COMPA_vect | ( | void | ) |
Interrupt routine for critical tasks.
This interrupt routine is in charge of sampling the encoder, process the data and handle PID
Definition at line 579 of file uStepperS.cpp.
Variable Documentation
◆ used
| void used |
Definition at line 251 of file uStepperS.h.
