You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
392 lines
18 KiB
392 lines
18 KiB
#ifndef TMC2310Stepper_h
|
|
#define TMC2310Stepper_h
|
|
|
|
//#define TMC2130DEBUG
|
|
|
|
#if defined(ARDUINO) && ARDUINO >= 100
|
|
#include <Arduino.h>
|
|
#endif
|
|
|
|
const uint32_t TMC2130Stepper_version = 0x10100; // v1.1.0
|
|
|
|
class TMC2130Stepper {
|
|
public:
|
|
TMC2130Stepper(uint8_t pinEN, uint8_t pinDIR, uint8_t pinStep, uint8_t pinCS);
|
|
void begin();
|
|
void checkStatus();
|
|
void rms_current(uint16_t mA, float multiplier=0.5, float RS=0.11);
|
|
uint16_t rms_current();
|
|
void SilentStepStick2130(uint16_t mA);
|
|
void setCurrent(uint16_t mA, float Rsense, float multiplier);
|
|
uint16_t getCurrent();
|
|
bool checkOT();
|
|
bool getOTPW();
|
|
void clear_otpw();
|
|
bool isEnabled();
|
|
// void takeSteps(int steps);
|
|
// void step(int steps, int speed);
|
|
// GCONF
|
|
uint32_t GCONF();
|
|
void GCONF( uint32_t value);
|
|
void I_scale_analog( bool B);
|
|
void internal_Rsense( bool B);
|
|
void en_pwm_mode( bool B);
|
|
void enc_commutation( bool B);
|
|
void shaft( bool B);
|
|
void diag0_error( bool B);
|
|
void diag0_otpw( bool B);
|
|
void diag0_stall( bool B);
|
|
void diag1_stall( bool B);
|
|
void diag1_index( bool B);
|
|
void diag1_onstate( bool B);
|
|
void diag1_steps_skipped( bool B);
|
|
void diag0_int_pushpull( bool B);
|
|
void diag1_pushpull( bool B);
|
|
void small_hysterisis( bool B);
|
|
void stop_enable( bool B);
|
|
void direct_mode( bool B);
|
|
bool I_scale_analog();
|
|
bool internal_Rsense();
|
|
bool en_pwm_mode();
|
|
bool enc_commutation();
|
|
bool shaft();
|
|
bool diag0_error();
|
|
bool diag0_otpw();
|
|
bool diag0_stall();
|
|
bool diag1_stall();
|
|
bool diag1_index();
|
|
bool diag1_onstate();
|
|
bool diag1_steps_skipped();
|
|
bool diag0_int_pushpull();
|
|
bool diag1_pushpull();
|
|
bool small_hysterisis();
|
|
bool stop_enable();
|
|
bool direct_mode();
|
|
// IHOLD_IRUN
|
|
void IHOLD_IRUN( uint32_t input);
|
|
uint32_t IHOLD_IRUN();
|
|
void ihold( uint8_t B);
|
|
void irun( uint8_t B);
|
|
void iholddelay( uint8_t B);
|
|
uint8_t ihold();
|
|
uint8_t irun();
|
|
uint8_t iholddelay();
|
|
// GSTAT
|
|
void GSTAT( uint8_t input);
|
|
uint8_t GSTAT();
|
|
bool reset();
|
|
bool drv_err();
|
|
bool uv_cp();
|
|
// IOIN
|
|
uint32_t IOIN();
|
|
bool step();
|
|
bool dir();
|
|
bool dcen_cfg4();
|
|
bool dcin_cfg5();
|
|
bool drv_enn_cfg6();
|
|
bool dco();
|
|
uint8_t version();
|
|
// TPOWERDOWN
|
|
uint32_t TPOWERDOWN();
|
|
void TPOWERDOWN( uint32_t input);
|
|
// TSTEP
|
|
uint32_t TSTEP();
|
|
// TPWMTHRS
|
|
uint32_t TPWMTHRS();
|
|
void TPWMTHRS( uint32_t input);
|
|
// TCOOLTHRS
|
|
uint32_t TCOOLTHRS();
|
|
void TCOOLTHRS( uint32_t input);
|
|
// THIGH
|
|
uint32_t THIGH();
|
|
void THIGH( uint32_t input);
|
|
// XDRIRECT
|
|
uint32_t XDIRECT();
|
|
void XDIRECT( uint32_t input);
|
|
void coil_A( int16_t B);
|
|
void coil_B( int16_t B);
|
|
int16_t coil_A();
|
|
int16_t coil_B();
|
|
// VDCMIN
|
|
uint32_t VDCMIN();
|
|
void VDCMIN( uint32_t input);
|
|
// CHOPCONF
|
|
uint32_t CHOPCONF();
|
|
void CHOPCONF( uint32_t value);
|
|
void toff( uint8_t B);
|
|
void hstrt( uint8_t B);
|
|
void hend( int8_t B);
|
|
void fd( uint8_t B);
|
|
void disfdcc( bool B);
|
|
void rndtf( bool B);
|
|
void chm( bool B);
|
|
void tbl( uint8_t B);
|
|
void vsense( bool B);
|
|
void vhighfs( bool B);
|
|
void vhighchm( bool B);
|
|
void sync( uint8_t B);
|
|
void mres( uint8_t B);
|
|
void intpol( bool B);
|
|
void dedge( bool B);
|
|
void diss2g( bool B);
|
|
uint8_t toff();
|
|
uint8_t hstrt();
|
|
int8_t hend();
|
|
uint8_t fd();
|
|
bool disfdcc();
|
|
bool rndtf();
|
|
bool chm();
|
|
uint8_t tbl();
|
|
bool vsense();
|
|
bool vhighfs();
|
|
bool vhighchm();
|
|
uint8_t sync();
|
|
uint8_t mres();
|
|
bool intpol();
|
|
bool dedge();
|
|
bool diss2g();
|
|
// COOLCONF
|
|
void COOLCONF(uint32_t value);
|
|
uint32_t COOLCONF();
|
|
void semin( uint8_t B);
|
|
void seup( uint8_t B);
|
|
void semax( uint8_t B);
|
|
void sedn( uint8_t B);
|
|
void seimin( bool B);
|
|
void sgt( uint8_t B);
|
|
void sfilt( bool B);
|
|
uint8_t semin();
|
|
uint8_t seup();
|
|
uint8_t semax();
|
|
uint8_t sedn();
|
|
bool seimin();
|
|
uint8_t sgt();
|
|
bool sfilt();
|
|
// PWMCONF
|
|
void PWMCONF( uint32_t value);
|
|
uint32_t PWMCONF();
|
|
void pwm_ampl( uint8_t B);
|
|
void pwm_grad( uint8_t B);
|
|
void pwm_freq( uint8_t B);
|
|
void pwm_autoscale( bool B);
|
|
void pwm_symmetric( bool B);
|
|
void freewheel( uint8_t B);
|
|
uint8_t pwm_ampl();
|
|
uint8_t pwm_grad();
|
|
uint8_t pwm_freq();
|
|
bool pwm_autoscale();
|
|
bool pwm_symmetric();
|
|
uint8_t freewheel();
|
|
// DRVSTATUS
|
|
uint32_t DRV_STATUS();
|
|
uint16_t sg_result();
|
|
bool fsactive();
|
|
uint8_t cs_actual();
|
|
bool stallguard();
|
|
bool ot();
|
|
bool otpw();
|
|
bool s2ga();
|
|
bool s2gb();
|
|
bool ola();
|
|
bool olb();
|
|
bool stst();
|
|
// PWM_SCALE
|
|
uint8_t PWM_SCALE();
|
|
// ENCM_CTRL
|
|
uint8_t ENCM_CTRL();
|
|
void ENCM_CTRL( uint8_t input);
|
|
void inv( bool B);
|
|
void maxspeed( bool B);
|
|
bool inv();
|
|
bool maxspeed();
|
|
// LOST_STEPS
|
|
uint32_t LOST_STEPS();
|
|
|
|
// Helper functions
|
|
void microsteps(uint16_t ms);
|
|
uint16_t microsteps();
|
|
void blank_time(uint8_t value);
|
|
uint8_t blank_time();
|
|
void hysterisis_end(int8_t value);
|
|
int8_t hysterisis_end();
|
|
void hysterisis_start(uint8_t value);
|
|
uint8_t hysterisis_start();
|
|
void sg_current_decrease(uint8_t value);
|
|
uint8_t sg_current_decrease();
|
|
|
|
// Aliases
|
|
|
|
// RW: GCONF
|
|
inline bool external_ref() __attribute__((always_inline)) { return I_scale_analog(); }
|
|
inline bool internal_sense_R() __attribute__((always_inline)) { return internal_Rsense(); }
|
|
inline bool stealthChop() __attribute__((always_inline)) { return en_pwm_mode(); }
|
|
inline bool commutation() __attribute__((always_inline)) { return enc_commutation(); }
|
|
inline bool shaft_dir() __attribute__((always_inline)) { return shaft(); }
|
|
inline bool diag0_errors() __attribute__((always_inline)) { return diag0_error(); }
|
|
inline bool diag0_temp_prewarn() __attribute__((always_inline)) { return diag0_otpw(); }
|
|
inline bool diag1_chopper_on() __attribute__((always_inline)) { return diag1_onstate(); }
|
|
inline bool diag0_active_high() __attribute__((always_inline)) { return diag0_int_pushpull(); }
|
|
inline bool diag1_active_high() __attribute__((always_inline)) { return diag1_pushpull(); }
|
|
inline void external_ref( bool value) __attribute__((always_inline)) { I_scale_analog(value); }
|
|
inline void internal_sense_R( bool value) __attribute__((always_inline)) { internal_Rsense(value); }
|
|
inline void stealthChop( bool value) __attribute__((always_inline)) { en_pwm_mode(value); }
|
|
inline void commutation( bool value) __attribute__((always_inline)) { enc_commutation(value); }
|
|
inline void shaft_dir( bool value) __attribute__((always_inline)) { shaft(value); }
|
|
inline void diag0_errors( bool value) __attribute__((always_inline)) { diag0_error(value); }
|
|
inline void diag0_temp_prewarn( bool value) __attribute__((always_inline)) { diag0_otpw(value); }
|
|
inline void diag1_chopper_on( bool value) __attribute__((always_inline)) { diag1_onstate(value); }
|
|
inline void diag0_active_high( bool value) __attribute__((always_inline)) { diag0_int_pushpull(value); }
|
|
inline void diag1_active_high( bool value) __attribute__((always_inline)) { diag1_pushpull(value); }
|
|
// RC
|
|
inline uint8_t status_flags() __attribute__((always_inline)) { return GSTAT(); }
|
|
// R
|
|
inline uint32_t input() __attribute__((always_inline)) { return IOIN(); }
|
|
// W: IHOLD_IRUN
|
|
inline uint8_t hold_current() __attribute__((always_inline)) { return ihold(); }
|
|
inline uint8_t run_current() __attribute__((always_inline)) { return irun(); }
|
|
inline uint8_t hold_delay() __attribute__((always_inline)) { return iholddelay(); }
|
|
inline void hold_current( uint8_t value) __attribute__((always_inline)) { ihold(value); }
|
|
inline void run_current( uint8_t value) __attribute__((always_inline)) { irun(value); }
|
|
inline void hold_delay( uint8_t value) __attribute__((always_inline)) { iholddelay(value); }
|
|
// W
|
|
inline uint8_t power_down_delay() __attribute__((always_inline)) { return TPOWERDOWN(); }
|
|
inline void power_down_delay( uint8_t value) __attribute__((always_inline)) { TPOWERDOWN(value); }
|
|
// R
|
|
inline uint32_t microstep_time() __attribute__((always_inline)) { return TSTEP(); }
|
|
// W
|
|
inline uint32_t stealth_max_speed() __attribute__((always_inline)) { return TPWMTHRS(); }
|
|
inline void stealth_max_speed(uint32_t value) __attribute__((always_inline)) { TPWMTHRS(value); }
|
|
// W
|
|
inline uint32_t coolstep_min_speed() __attribute__((always_inline)) { return TCOOLTHRS(); }
|
|
inline void coolstep_min_speed(uint32_t value) __attribute__((always_inline)) { TCOOLTHRS(value); }
|
|
// W
|
|
inline uint32_t mode_sw_speed() __attribute__((always_inline)) { return THIGH(); }
|
|
inline void mode_sw_speed( uint32_t value) __attribute__((always_inline)) { THIGH(value); }
|
|
// RW: XDIRECT
|
|
inline int16_t coil_A_current() __attribute__((always_inline)) { return coil_A(); }
|
|
inline void coil_A_current( int16_t value) __attribute__((always_inline)) { coil_B(value); }
|
|
inline int16_t coil_B_current() __attribute__((always_inline)) { return coil_A(); }
|
|
inline void coil_B_current( int16_t value) __attribute__((always_inline)) { coil_B(value); }
|
|
// W
|
|
inline uint32_t DCstep_min_speed() __attribute__((always_inline)) { return VDCMIN(); }
|
|
inline void DCstep_min_speed( uint32_t value) __attribute__((always_inline)) { VDCMIN(value); }
|
|
// RW: CHOPCONF
|
|
inline uint8_t off_time() __attribute__((always_inline)) { return toff(); }
|
|
// inline uint8_t hysterisis_start() __attribute__((always_inline)) { return hstrt(); }
|
|
// inline int8_t hysterisis_low() __attribute__((always_inline)) { return hend(); }
|
|
inline int8_t hysterisis_low() __attribute__((always_inline)) { return hysterisis_end(); }
|
|
inline uint8_t fast_decay_time() __attribute__((always_inline)) { return fd(); }
|
|
inline bool disable_I_comparator() __attribute__((always_inline)) { return disfdcc(); }
|
|
inline bool random_off_time() __attribute__((always_inline)) { return rndtf(); }
|
|
inline bool chopper_mode() __attribute__((always_inline)) { return chm(); }
|
|
// inline uint8_t blank_time() __attribute__((always_inline)) { return tbl(); }
|
|
inline bool high_sense_R() __attribute__((always_inline)) { return vsense(); }
|
|
inline bool fullstep_threshold() __attribute__((always_inline)) { return vhighfs(); }
|
|
inline bool high_speed_mode() __attribute__((always_inline)) { return vhighchm(); }
|
|
inline uint8_t sync_phases() __attribute__((always_inline)) { return sync(); }
|
|
// inline uint16_t microsteps() __attribute__((always_inline)) { return mres(); }
|
|
inline bool interpolate() __attribute__((always_inline)) { return intpol(); }
|
|
inline bool double_edge_step() __attribute__((always_inline)) { return dedge(); }
|
|
inline bool disable_short_protection() __attribute__((always_inline)) { return diss2g(); }
|
|
inline void off_time( uint8_t value) __attribute__((always_inline)) { toff(value); }
|
|
// inline void hysterisis_start( uint8_t value) __attribute__((always_inline)) { hstrt(value); }
|
|
// inline void hysterisis_low( int8_t value) __attribute__((always_inline)) { hend(value); }
|
|
inline void hysterisis_low( int8_t value) __attribute__((always_inline)) { hysterisis_end(value); }
|
|
inline void fast_decay_time( uint8_t value) __attribute__((always_inline)) { fd(value); }
|
|
inline void disable_I_comparator( bool value) __attribute__((always_inline)) { disfdcc(value); }
|
|
inline void random_off_time( bool value) __attribute__((always_inline)) { rndtf(value); }
|
|
inline void chopper_mode( bool value) __attribute__((always_inline)) { chm(value); }
|
|
// inline void blank_time( uint8_t value) __attribute__((always_inline)) { tbl(value); }
|
|
inline void high_sense_R( bool value) __attribute__((always_inline)) { vsense(value); }
|
|
inline void fullstep_threshold( bool value) __attribute__((always_inline)) { vhighfs(value); }
|
|
inline void high_speed_mode( bool value) __attribute__((always_inline)) { vhighchm(value); }
|
|
inline void sync_phases( uint8_t value) __attribute__((always_inline)) { sync(value); }
|
|
// inline void microsteps( uint16_t value) __attribute__((always_inline)) { mres(value); }
|
|
inline void interpolate( bool value) __attribute__((always_inline)) { intpol(value); }
|
|
inline void double_edge_step( bool value) __attribute__((always_inline)) { dedge(value); }
|
|
inline void disable_short_protection(bool value)__attribute__((always_inline)) { diss2g(value); }
|
|
// W: COOLCONF
|
|
inline uint8_t sg_min() __attribute__((always_inline)) { return semin(); }
|
|
inline uint8_t sg_step_width() __attribute__((always_inline)) { return seup(); }
|
|
inline uint8_t sg_max() __attribute__((always_inline)) { return semax(); }
|
|
// inline uint8_t sg_current_decrease() __attribute__((always_inline)) { return sedn(); }
|
|
inline uint8_t smart_min_current() __attribute__((always_inline)) { return seimin(); }
|
|
inline int8_t sg_stall_value() __attribute__((always_inline)) { return sgt(); }
|
|
inline bool sg_filter() __attribute__((always_inline)) { return sfilt(); }
|
|
inline void sg_min( uint8_t value) __attribute__((always_inline)) { semin(value); }
|
|
inline void sg_step_width( uint8_t value) __attribute__((always_inline)) { seup(value); }
|
|
inline void sg_max( uint8_t value) __attribute__((always_inline)) { semax(value); }
|
|
// inline void sg_current_decrease(uint8_t value)__attribute__((always_inline)) { sedn(value); }
|
|
inline void smart_min_current( uint8_t value) __attribute__((always_inline)) { seimin(value); }
|
|
inline void sg_stall_value( int8_t value) __attribute__((always_inline)) { sgt(value); }
|
|
inline void sg_filter( bool value) __attribute__((always_inline)) { sfilt(value); }
|
|
// W: PWMCONF
|
|
inline uint8_t stealth_amplitude() __attribute__((always_inline)) { return pwm_ampl(); }
|
|
inline uint8_t stealth_gradient() __attribute__((always_inline)) { return pwm_grad(); }
|
|
inline uint8_t stealth_freq() __attribute__((always_inline)) { return pwm_freq(); }
|
|
inline bool stealth_autoscale() __attribute__((always_inline)) { return pwm_autoscale(); }
|
|
inline bool stealth_symmetric() __attribute__((always_inline)) { return pwm_symmetric(); }
|
|
inline uint8_t standstill_mode() __attribute__((always_inline)) { return freewheel(); }
|
|
inline void stealth_amplitude( uint8_t value) __attribute__((always_inline)) { pwm_ampl(value); }
|
|
inline void stealth_gradient( uint8_t value) __attribute__((always_inline)) { pwm_grad(value); }
|
|
inline void stealth_freq( uint8_t value) __attribute__((always_inline)) { pwm_freq(value); }
|
|
inline void stealth_autoscale( bool value) __attribute__((always_inline)) { pwm_autoscale(value); }
|
|
inline void stealth_symmetric( bool value) __attribute__((always_inline)) { pwm_symmetric(value); }
|
|
inline void standstill_mode( uint8_t value) __attribute__((always_inline)) { freewheel(value); }
|
|
// W: ENCM_CTRL
|
|
inline bool invert_encoder() __attribute__((always_inline)) { return inv(); }
|
|
inline void invert_encoder( bool value) __attribute__((always_inline)) { inv(value); }
|
|
// R: DRV_STATUS
|
|
inline uint32_t DRVSTATUS() __attribute__((always_inline)) { return DRV_STATUS(); }
|
|
|
|
|
|
float Rsense = 0.11;
|
|
bool _started;
|
|
uint8_t status_response;
|
|
bool flag_otpw = false;
|
|
|
|
private:
|
|
//const uint8_t WRITE = 0b10000000;
|
|
//const uint8_t READ = 0b00000000;
|
|
uint8_t _pinEN = 16;
|
|
uint8_t _pinSTEP = 18;
|
|
uint8_t _pinCS = 17;
|
|
//const int MOSI_PIN = 12;
|
|
//const int MISO_PIN = 11;
|
|
//const int SCK_PIN = 13;
|
|
uint8_t _pinDIR = 19;
|
|
|
|
// Shadow registers
|
|
uint32_t GCONF_sr = 0x00000000UL,
|
|
IHOLD_IRUN_sr = 0x00000000UL,
|
|
TSTEP_sr = 0x00000000UL,
|
|
TPWMTHRS_sr = 0x00000000UL,
|
|
TCOOLTHRS_sr = 0x00000000UL,
|
|
THIGH_sr = 0x00000000UL,
|
|
XDIRECT_sr = 0x00000000UL,
|
|
VDCMIN_sr = 0x00000000UL,
|
|
MSLUT0_sr = 0x00000000UL,
|
|
MSLUT1_sr = 0x00000000UL,
|
|
MSLUT2_sr = 0x00000000UL,
|
|
MSLUT3_sr = 0x00000000UL,
|
|
MSLUT4_sr = 0x00000000UL,
|
|
MSLUT5_sr = 0x00000000UL,
|
|
MSLUT6_sr = 0x00000000UL,
|
|
MSLUT7_sr = 0x00000000UL,
|
|
MSLUTSEL_sr = 0x00000000UL,
|
|
CHOPCONF_sr = 0x00000000UL,
|
|
COOLCONF_sr = 0x00000000UL,
|
|
DCCTRL_sr = 0x00000000UL,
|
|
PWMCONF_sr = 0x00050480UL,
|
|
tmp_sr = 0x00000000UL,
|
|
TPOWERDOWN_sr = 0x00000000UL,
|
|
ENCM_CTRL_sr = 0x00000000UL,
|
|
GSTAT_sr = 0x00000000UL,
|
|
MSLUTSTART_sr = 0x00000000UL;
|
|
|
|
void send2130(uint8_t addressByte, uint32_t *config);
|
|
|
|
uint16_t val_mA = 0;
|
|
};
|
|
|
|
#endif |