#include <TMC2208Stepper.h>

Inheritance diagram for TMC2208Stepper:

Collaboration diagram for TMC2208Stepper:

Classes
struct	IFCNT_t
struct	OTP_PROG_t
struct	OTP_READ_t

Public Member Functions
	TMC2208Stepper (Stream *SerialPort, float RS, uint8_t addr, uint16_t mul_pin1, uint16_t mul_pin2)
	TMC2208Stepper (Stream *SerialPort, float RS)
	TMC2208Stepper (uint16_t, uint16_t, float)=delete
void	defaults ()
void	push ()
void	begin ()
void	beginSerial (uint32_t)=delete
bool	isEnabled ()
void	GCONF (uint32_t input)
void	I_scale_analog (bool B)
void	internal_Rsense (bool B)
void	en_spreadCycle (bool B)
void	shaft (bool B)
void	index_otpw (bool B)
void	index_step (bool B)
void	pdn_disable (bool B)
void	mstep_reg_select (bool B)
void	multistep_filt (bool B)
uint32_t	GCONF ()
bool	I_scale_analog ()
bool	internal_Rsense ()
bool	en_spreadCycle ()
bool	shaft ()
bool	index_otpw ()
bool	index_step ()
bool	pdn_disable ()
bool	mstep_reg_select ()
bool	multistep_filt ()
uint8_t	IFCNT ()
void	SLAVECONF (uint16_t input)
uint16_t	SLAVECONF ()
void	senddelay (uint8_t B)
uint8_t	senddelay ()
void	OTP_PROG (uint16_t input)
uint32_t	OTP_READ ()
uint32_t	IOIN ()
bool	enn ()
bool	ms1 ()
bool	ms2 ()
bool	diag ()
bool	pdn_uart ()
bool	step ()
bool	sel_a ()
bool	dir ()
uint8_t	version ()
void	FACTORY_CONF (uint16_t input)
uint16_t	FACTORY_CONF ()
void	fclktrim (uint8_t B)
void	ottrim (uint8_t B)
uint8_t	fclktrim ()
uint8_t	ottrim ()
void	VACTUAL (uint32_t input)
uint32_t	VACTUAL ()
void	CHOPCONF (uint32_t input)
void	toff (uint8_t B)
void	hstrt (uint8_t B)
void	hend (uint8_t B)
void	tbl (uint8_t B)
void	vsense (bool B)
void	mres (uint8_t B)
void	intpol (bool B)
void	dedge (bool B)
void	diss2g (bool B)
void	diss2vs (bool B)
uint32_t	CHOPCONF ()
uint8_t	toff ()
uint8_t	hstrt ()
uint8_t	hend ()
uint8_t	tbl ()
bool	vsense ()
uint8_t	mres ()
bool	intpol ()
bool	dedge ()
bool	diss2g ()
bool	diss2vs ()
uint32_t	DRV_STATUS ()
bool	otpw ()
bool	ot ()
bool	s2ga ()
bool	s2gb ()
bool	s2vsa ()
bool	s2vsb ()
bool	ola ()
bool	olb ()
bool	t120 ()
bool	t143 ()
bool	t150 ()
bool	t157 ()
uint16_t	cs_actual ()
bool	stealth ()
bool	stst ()
void	PWMCONF (uint32_t input)
void	pwm_ofs (uint8_t B)
void	pwm_grad (uint8_t B)
void	pwm_freq (uint8_t B)
void	pwm_autoscale (bool B)
void	pwm_autograd (bool B)
void	freewheel (uint8_t B)
void	pwm_reg (uint8_t B)
void	pwm_lim (uint8_t B)
uint32_t	PWMCONF ()
uint8_t	pwm_ofs ()
uint8_t	pwm_grad ()
uint8_t	pwm_freq ()
bool	pwm_autoscale ()
bool	pwm_autograd ()
uint8_t	freewheel ()
uint8_t	pwm_reg ()
uint8_t	pwm_lim ()
uint32_t	PWM_SCALE ()
uint8_t	pwm_scale_sum ()
int16_t	pwm_scale_auto ()
uint32_t	PWM_AUTO ()
uint8_t	pwm_ofs_auto ()
uint8_t	pwm_grad_auto ()
uint32_t	MSCURACT ()
int16_t	cur_a ()
int16_t	cur_b ()
Public Member Functions inherited from TMCStepper
uint16_t	cs2rms (uint8_t CS)
void	rms_current (uint16_t mA)
void	rms_current (uint16_t mA, float mult)
uint16_t	rms_current ()
void	hold_multiplier (float val)
float	hold_multiplier ()
uint8_t	test_connection ()
void	microsteps (uint16_t ms)
uint16_t	microsteps ()
void	blank_time (uint8_t value)
uint8_t	blank_time ()
void	hysteresis_end (int8_t value)
int8_t	hysteresis_end ()
void	hysteresis_start (uint8_t value)
uint8_t	hysteresis_start ()
void	GSTAT (uint8_t input)
uint8_t	GSTAT ()
bool	reset ()
bool	drv_err ()
bool	uv_cp ()
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 ()
uint8_t	TPOWERDOWN ()
void	TPOWERDOWN (uint8_t input)
uint32_t	TSTEP ()
uint32_t	TPWMTHRS ()
void	TPWMTHRS (uint32_t input)
uint16_t	MSCNT ()

Public Attributes
uint16_t	bytesWritten = 0
float	Rsense = 0.11
bool	CRCerror = false

Protected Member Functions
	INIT2208_REGISTER (GCONF)
	INIT_REGISTER (SLAVECONF)
	INIT_REGISTER (FACTORY_CONF)
	INIT2208_REGISTER (VACTUAL)
	INIT2208_REGISTER (CHOPCONF)
	INIT2208_REGISTER (PWMCONF)
	TMC2208Stepper (Stream *SerialPort, float RS, uint8_t addr)
int	available ()
void	preWriteCommunication ()
void	preReadCommunication ()
int16_t	serial_read ()
uint8_t	serial_write (const uint8_t data)
void	postWriteCommunication ()
void	postReadCommunication ()
void	write (uint8_t, uint32_t)
uint32_t	read (uint8_t)
uint8_t	calcCRC (uint8_t datagram[], uint8_t len)
uint64_t	_sendDatagram (uint8_t[], const uint8_t, uint16_t)
Protected Member Functions inherited from TMCStepper
	TMCStepper (float RS)
virtual	~TMCStepper ()=default
	INIT_REGISTER (IHOLD_IRUN)
	INIT_REGISTER (TPOWERDOWN)
	INIT_REGISTER (TPWMTHRS)

Protected Attributes
Stream *	HWSerial = nullptr
SSwitch *	sswitch = nullptr
const uint8_t	slave_address
Protected Attributes inherited from TMCStepper
const float	Rsense
float	holdMultiplier = 0.5

Static Protected Attributes
static constexpr uint8_t	TMC2208_SYNC = 0x05
static constexpr uint8_t	TMC2208_SLAVE_ADDR = 0x00
static constexpr uint8_t	replyDelay = 2
static constexpr uint8_t	abort_window = 8
static constexpr uint8_t	max_retries = 2
Static Protected Attributes inherited from TMCStepper
static constexpr uint8_t	TMC_READ = 0x00
static constexpr uint8_t	TMC_WRITE = 0x80

Detailed Description

Definition at line 11 of file TMC2208Stepper.h.

Constructor & Destructor Documentation

◆ TMC2208Stepper() [1/4]

TMC2208Stepper::TMC2208Stepper	(	Stream *	SerialPort,
		float	RS,
		uint8_t	addr,
		uint16_t	mul_pin1,
		uint16_t	mul_pin2 )

Definition at line 24 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TMC2208Stepper() [2/4]

TMC2208Stepper::TMC2208Stepper	(	Stream *	SerialPort,
		float	RS )

inline

Definition at line 14 of file TMC2208Stepper.h.

Here is the call graph for this function:

◆ TMC2208Stepper() [3/4]

TMC2208Stepper::TMC2208Stepper	(	uint16_t	,
		uint16_t	,
		float	)

delete

◆ TMC2208Stepper() [4/4]

TMC2208Stepper::TMC2208Stepper	(	Stream *	SerialPort,
		float	RS,
		uint8_t	addr )

protected

TMCStepper library by @teemuatlut TMC2208Stepper.cpp Implementing methods for TMC2208 (TMC2209, TMC2224)

Definition at line 16 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ _sendDatagram()

uint64_t TMC2208Stepper::_sendDatagram	(	uint8_t	datagram[],
		const uint8_t	len,
		uint16_t	timeout )

protected

Definition at line 269 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ available()

int TMC2208Stepper::available ( )

protected

Here is the caller graph for this function:

◆ begin()

void TMC2208Stepper::begin ( )

Definition at line 61 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ beginSerial()

void TMC2208Stepper::beginSerial ( uint32_t )

delete

Here is the caller graph for this function:

◆ calcCRC()

uint8_t TMC2208Stepper::calcCRC	(	uint8_t	datagram[],
		uint8_t	len )

protected

Definition at line 128 of file TMC2208Stepper.cpp.

Here is the caller graph for this function:

◆ CHOPCONF() [1/2]

uint32_t TMC2208Stepper::CHOPCONF ( )

Definition at line 70 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CHOPCONF() [2/2]

void TMC2208Stepper::CHOPCONF ( uint32_t input )

Definition at line 71 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cs_actual()

uint16_t TMC2208Stepper::cs_actual ( )

Definition at line 51 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cur_a()

int16_t TMC2208Stepper::cur_a ( )

Definition at line 441 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ cur_b()

int16_t TMC2208Stepper::cur_b ( )

Definition at line 448 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ dedge() [1/2]

bool TMC2208Stepper::dedge ( )

Definition at line 93 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ dedge() [2/2]

void TMC2208Stepper::dedge ( bool B )

Definition at line 82 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defaults()

void TMC2208Stepper::defaults ( )

Definition at line 72 of file TMC2208Stepper.cpp.

Here is the caller graph for this function:

◆ diag()

bool TMC2208Stepper::diag ( )

Definition at line 48 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dir()

bool TMC2208Stepper::dir ( )

Definition at line 52 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diss2g() [1/2]

bool TMC2208Stepper::diss2g ( )

Definition at line 94 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ diss2g() [2/2]

void TMC2208Stepper::diss2g ( bool B )

Definition at line 83 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diss2vs() [1/2]

bool TMC2208Stepper::diss2vs ( )

Definition at line 95 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ diss2vs() [2/2]

void TMC2208Stepper::diss2vs ( bool B )

Definition at line 84 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DRV_STATUS()

uint32_t TMC2208Stepper::DRV_STATUS ( )

virtual

Implements TMCStepper.

Definition at line 35 of file DRV_STATUS.cpp.

Here is the call graph for this function:

◆ en_spreadCycle() [1/2]

bool TMC2208Stepper::en_spreadCycle ( )

Definition at line 105 of file GCONF.cpp.

◆ en_spreadCycle() [2/2]

void TMC2208Stepper::en_spreadCycle ( bool B )

Definition at line 95 of file GCONF.cpp.

◆ enn()

bool TMC2208Stepper::enn ( )

Definition at line 45 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FACTORY_CONF() [1/2]

uint16_t TMC2208Stepper::FACTORY_CONF ( )

Definition at line 396 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FACTORY_CONF() [2/2]

void TMC2208Stepper::FACTORY_CONF ( uint16_t input )

Definition at line 397 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fclktrim() [1/2]

uint8_t TMC2208Stepper::fclktrim ( )

Definition at line 403 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ fclktrim() [2/2]

void TMC2208Stepper::fclktrim ( uint8_t B )

Definition at line 401 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ freewheel() [1/2]

uint8_t TMC2208Stepper::freewheel ( )

Definition at line 93 of file PWMCONF.cpp.

Here is the call graph for this function:

◆ freewheel() [2/2]

void TMC2208Stepper::freewheel ( uint8_t B )

Definition at line 84 of file PWMCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GCONF() [1/2]

uint32_t TMC2208Stepper::GCONF ( )

Definition at line 85 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GCONF() [2/2]

void TMC2208Stepper::GCONF ( uint32_t input )

Definition at line 88 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hend() [1/2]

uint8_t TMC2208Stepper::hend ( )

virtual

Implements TMCStepper.

Definition at line 88 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ hend() [2/2]

void TMC2208Stepper::hend ( uint8_t B )

virtual

Implements TMCStepper.

Definition at line 77 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hstrt() [1/2]

uint8_t TMC2208Stepper::hstrt ( )

virtual

Implements TMCStepper.

Definition at line 87 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ hstrt() [2/2]

void TMC2208Stepper::hstrt ( uint8_t B )

virtual

Implements TMCStepper.

Definition at line 76 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ I_scale_analog() [1/2]

bool TMC2208Stepper::I_scale_analog ( )

Definition at line 103 of file GCONF.cpp.

◆ I_scale_analog() [2/2]

void TMC2208Stepper::I_scale_analog ( bool B )

Definition at line 93 of file GCONF.cpp.

◆ IFCNT()

uint8_t TMC2208Stepper::IFCNT ( )

Definition at line 388 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ index_otpw() [1/2]

bool TMC2208Stepper::index_otpw ( )

Definition at line 107 of file GCONF.cpp.

Here is the call graph for this function:

◆ index_otpw() [2/2]

void TMC2208Stepper::index_otpw ( bool B )

Definition at line 97 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index_step() [1/2]

bool TMC2208Stepper::index_step ( )

Definition at line 108 of file GCONF.cpp.

Here is the call graph for this function:

◆ index_step() [2/2]

void TMC2208Stepper::index_step ( bool B )

Definition at line 98 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ INIT2208_REGISTER() [1/4]

TMC2208Stepper::INIT2208_REGISTER ( CHOPCONF )

protected

Here is the call graph for this function:

◆ INIT2208_REGISTER() [2/4]

TMC2208Stepper::INIT2208_REGISTER ( GCONF )

protected

Here is the call graph for this function:

◆ INIT2208_REGISTER() [3/4]

TMC2208Stepper::INIT2208_REGISTER ( PWMCONF )

protected

Here is the call graph for this function:

◆ INIT2208_REGISTER() [4/4]

TMC2208Stepper::INIT2208_REGISTER ( VACTUAL )

protected

Here is the call graph for this function:

◆ INIT_REGISTER() [1/2]

TMC2208Stepper::INIT_REGISTER ( FACTORY_CONF )

protected

Here is the call graph for this function:

◆ INIT_REGISTER() [2/2]

TMC2208Stepper::INIT_REGISTER ( SLAVECONF )

protected

Here is the call graph for this function:

◆ internal_Rsense() [1/2]

bool TMC2208Stepper::internal_Rsense ( )

Definition at line 104 of file GCONF.cpp.

◆ internal_Rsense() [2/2]

void TMC2208Stepper::internal_Rsense ( bool B )

Definition at line 94 of file GCONF.cpp.

◆ intpol() [1/2]

bool TMC2208Stepper::intpol ( )

Definition at line 92 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ intpol() [2/2]

void TMC2208Stepper::intpol ( bool B )

Definition at line 81 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IOIN()

uint32_t TMC2208Stepper::IOIN ( )

Definition at line 44 of file IOIN.cpp.

Here is the call graph for this function:

◆ isEnabled()

bool TMC2208Stepper::isEnabled ( )

Definition at line 126 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ mres() [1/2]

uint8_t TMC2208Stepper::mres ( )

virtual

Implements TMCStepper.

Definition at line 91 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ mres() [2/2]

void TMC2208Stepper::mres ( uint8_t B )

virtual

Implements TMCStepper.

Definition at line 80 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ms1()

bool TMC2208Stepper::ms1 ( )

Definition at line 46 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ms2()

bool TMC2208Stepper::ms2 ( )

Definition at line 47 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MSCURACT()

uint32_t TMC2208Stepper::MSCURACT ( )

Definition at line 440 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mstep_reg_select() [1/2]

bool TMC2208Stepper::mstep_reg_select ( )

Definition at line 110 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mstep_reg_select() [2/2]

void TMC2208Stepper::mstep_reg_select ( bool B )

Definition at line 100 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ multistep_filt() [1/2]

bool TMC2208Stepper::multistep_filt ( )

Definition at line 111 of file GCONF.cpp.

Here is the call graph for this function:

◆ multistep_filt() [2/2]

void TMC2208Stepper::multistep_filt ( bool B )

Definition at line 101 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ola()

bool TMC2208Stepper::ola ( )

Definition at line 45 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ olb()

bool TMC2208Stepper::olb ( )

Definition at line 46 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ot()

bool TMC2208Stepper::ot ( )

Definition at line 40 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OTP_PROG()

void TMC2208Stepper::OTP_PROG ( uint16_t input )

Definition at line 390 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ OTP_READ()

uint32_t TMC2208Stepper::OTP_READ ( )

Definition at line 394 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ otpw()

bool TMC2208Stepper::otpw ( )

Definition at line 39 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ottrim() [1/2]

uint8_t TMC2208Stepper::ottrim ( )

Definition at line 404 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ ottrim() [2/2]

void TMC2208Stepper::ottrim ( uint8_t B )

Definition at line 402 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ pdn_disable() [1/2]

bool TMC2208Stepper::pdn_disable ( )

Definition at line 109 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pdn_disable() [2/2]

void TMC2208Stepper::pdn_disable ( bool B )

Definition at line 99 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pdn_uart()

bool TMC2208Stepper::pdn_uart ( )

Definition at line 49 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ postReadCommunication()

void TMC2208Stepper::postReadCommunication ( )

protected

Here is the caller graph for this function:

◆ postWriteCommunication()

void TMC2208Stepper::postWriteCommunication ( )

protected

Here is the caller graph for this function:

◆ preReadCommunication()

void TMC2208Stepper::preReadCommunication ( )

protected

Here is the caller graph for this function:

◆ preWriteCommunication()

void TMC2208Stepper::preWriteCommunication ( )

protected

Here is the caller graph for this function:

◆ push()

void TMC2208Stepper::push ( )

Definition at line 115 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ PWM_AUTO()

uint32_t TMC2208Stepper::PWM_AUTO ( )

Definition at line 435 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pwm_autograd() [1/2]

bool TMC2208Stepper::pwm_autograd ( )

Definition at line 92 of file PWMCONF.cpp.

Here is the call graph for this function:

◆ pwm_autograd() [2/2]

void TMC2208Stepper::pwm_autograd ( bool B )

Definition at line 83 of file PWMCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pwm_autoscale() [1/2]

bool TMC2208Stepper::pwm_autoscale ( )

Definition at line 91 of file PWMCONF.cpp.

Here is the call graph for this function:

◆ pwm_autoscale() [2/2]

void TMC2208Stepper::pwm_autoscale ( bool B )

Definition at line 82 of file PWMCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pwm_freq() [1/2]

uint8_t TMC2208Stepper::pwm_freq ( )

Definition at line 90 of file PWMCONF.cpp.

Here is the call graph for this function:

◆ pwm_freq() [2/2]

void TMC2208Stepper::pwm_freq ( uint8_t B )

Definition at line 81 of file PWMCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pwm_grad() [1/2]

uint8_t TMC2208Stepper::pwm_grad ( )

Definition at line 89 of file PWMCONF.cpp.

Here is the call graph for this function:

◆ pwm_grad() [2/2]

void TMC2208Stepper::pwm_grad ( uint8_t B )

Definition at line 80 of file PWMCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pwm_grad_auto()

uint8_t TMC2208Stepper::pwm_grad_auto ( )

Definition at line 437 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ pwm_lim() [1/2]

uint8_t TMC2208Stepper::pwm_lim ( )

Definition at line 95 of file PWMCONF.cpp.

Here is the call graph for this function:

◆ pwm_lim() [2/2]

void TMC2208Stepper::pwm_lim ( uint8_t B )

Definition at line 86 of file PWMCONF.cpp.

Here is the caller graph for this function:

◆ pwm_ofs() [1/2]

uint8_t TMC2208Stepper::pwm_ofs ( )

Definition at line 88 of file PWMCONF.cpp.

◆ pwm_ofs() [2/2]

void TMC2208Stepper::pwm_ofs ( uint8_t B )

Definition at line 79 of file PWMCONF.cpp.

◆ pwm_ofs_auto()

uint8_t TMC2208Stepper::pwm_ofs_auto ( )

Definition at line 436 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ pwm_reg() [1/2]

uint8_t TMC2208Stepper::pwm_reg ( )

Definition at line 94 of file PWMCONF.cpp.

Here is the call graph for this function:

◆ pwm_reg() [2/2]

void TMC2208Stepper::pwm_reg ( uint8_t B )

Definition at line 85 of file PWMCONF.cpp.

Here is the caller graph for this function:

◆ PWM_SCALE()

uint32_t TMC2208Stepper::PWM_SCALE ( )

Definition at line 414 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pwm_scale_auto()

int16_t TMC2208Stepper::pwm_scale_auto ( )

Definition at line 421 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ pwm_scale_sum()

uint8_t TMC2208Stepper::pwm_scale_sum ( )

Definition at line 415 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

◆ PWMCONF() [1/2]

uint32_t TMC2208Stepper::PWMCONF ( )

Definition at line 71 of file PWMCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PWMCONF() [2/2]

void TMC2208Stepper::PWMCONF ( uint32_t input )

Definition at line 74 of file PWMCONF.cpp.

Here is the caller graph for this function:

◆ read()

uint32_t TMC2208Stepper::read ( uint8_t addr )

protectedvirtual

Implements TMCStepper.

Definition at line 350 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s2ga()

bool TMC2208Stepper::s2ga ( )

Definition at line 41 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s2gb()

bool TMC2208Stepper::s2gb ( )

Definition at line 42 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s2vsa()

bool TMC2208Stepper::s2vsa ( )

Definition at line 43 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s2vsb()

bool TMC2208Stepper::s2vsb ( )

Definition at line 44 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sel_a()

bool TMC2208Stepper::sel_a ( )

Definition at line 51 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ senddelay() [1/2]

uint8_t TMC2208Stepper::senddelay ( )

Definition at line 21 of file SLAVECONF.cpp.

Here is the call graph for this function:

◆ senddelay() [2/2]

void TMC2208Stepper::senddelay ( uint8_t B )

Definition at line 22 of file SLAVECONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serial_read()

int16_t TMC2208Stepper::serial_read ( )

protected

Here is the caller graph for this function:

◆ serial_write()

uint8_t TMC2208Stepper::serial_write ( const uint8_t data )

protected

Here is the caller graph for this function:

◆ shaft() [1/2]

bool TMC2208Stepper::shaft ( )

Definition at line 106 of file GCONF.cpp.

Here is the call graph for this function:

◆ shaft() [2/2]

void TMC2208Stepper::shaft ( bool B )

Definition at line 96 of file GCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SLAVECONF() [1/2]

uint16_t TMC2208Stepper::SLAVECONF ( )

Definition at line 16 of file SLAVECONF.cpp.

Here is the caller graph for this function:

◆ SLAVECONF() [2/2]

void TMC2208Stepper::SLAVECONF ( uint16_t input )

Definition at line 17 of file SLAVECONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stealth()

bool TMC2208Stepper::stealth ( )

Definition at line 52 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ step()

bool TMC2208Stepper::step ( )

Definition at line 50 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stst()

bool TMC2208Stepper::stst ( )

Definition at line 53 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ t120()

bool TMC2208Stepper::t120 ( )

Definition at line 47 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ t143()

bool TMC2208Stepper::t143 ( )

Definition at line 48 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ t150()

bool TMC2208Stepper::t150 ( )

Definition at line 49 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ t157()

bool TMC2208Stepper::t157 ( )

Definition at line 50 of file DRV_STATUS.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tbl() [1/2]

uint8_t TMC2208Stepper::tbl ( )

virtual

Implements TMCStepper.

Definition at line 89 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ tbl() [2/2]

void TMC2208Stepper::tbl ( uint8_t B )

virtual

Implements TMCStepper.

Definition at line 78 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toff() [1/2]

uint8_t TMC2208Stepper::toff ( )

Definition at line 86 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toff() [2/2]

void TMC2208Stepper::toff ( uint8_t B )

Definition at line 75 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VACTUAL() [1/2]

uint32_t TMC2208Stepper::VACTUAL ( )

Definition at line 410 of file TMC2208Stepper.cpp.

Here is the caller graph for this function:

◆ VACTUAL() [2/2]

void TMC2208Stepper::VACTUAL ( uint32_t input )

Definition at line 406 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ version()

uint8_t TMC2208Stepper::version ( )

Definition at line 53 of file IOIN.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ vsense() [1/2]

bool TMC2208Stepper::vsense ( void )

virtual

Implements TMCStepper.

Definition at line 90 of file CHOPCONF.cpp.

Here is the call graph for this function:

◆ vsense() [2/2]

void TMC2208Stepper::vsense ( bool B )

virtual

Implements TMCStepper.

Definition at line 79 of file CHOPCONF.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void TMC2208Stepper::write	(	uint8_t	addr,
		uint32_t	regVal )

protectedvirtual

Implements TMCStepper.

Definition at line 223 of file TMC2208Stepper.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ abort_window

uint8_t TMC2208Stepper::abort_window = 8

staticconstexprprotected

Definition at line 221 of file TMC2208Stepper.h.

◆ bytesWritten

uint16_t TMC2208Stepper::bytesWritten = 0

Definition at line 177 of file TMC2208Stepper.h.

◆ CRCerror

bool TMC2208Stepper::CRCerror = false

Definition at line 179 of file TMC2208Stepper.h.

◆ HWSerial

Stream* TMC2208Stepper::HWSerial = nullptr

protected

Definition at line 197 of file TMC2208Stepper.h.

◆ max_retries

uint8_t TMC2208Stepper::max_retries = 2

staticconstexprprotected

Definition at line 222 of file TMC2208Stepper.h.

◆ replyDelay

uint8_t TMC2208Stepper::replyDelay = 2

staticconstexprprotected

Definition at line 220 of file TMC2208Stepper.h.

◆ Rsense

float TMC2208Stepper::Rsense = 0.11

Definition at line 178 of file TMC2208Stepper.h.

◆ slave_address

const uint8_t TMC2208Stepper::slave_address

protected

Definition at line 216 of file TMC2208Stepper.h.

◆ sswitch

SSwitch* TMC2208Stepper::sswitch = nullptr

protected

Definition at line 205 of file TMC2208Stepper.h.

◆ TMC2208_SLAVE_ADDR

uint8_t TMC2208Stepper::TMC2208_SLAVE_ADDR = 0x00

staticprotected

Definition at line 219 of file TMC2208Stepper.h.

◆ TMC2208_SYNC

uint8_t TMC2208Stepper::TMC2208_SYNC = 0x05

staticconstexprprotected

Definition at line 218 of file TMC2208Stepper.h.

The documentation for this class was generated from the following files:

src/source/TMC2208Stepper.h
src/source/CHOPCONF.cpp
src/source/DRV_STATUS.cpp
src/source/GCONF.cpp
src/source/IOIN.cpp
src/source/PWMCONF.cpp
src/source/SLAVECONF.cpp
src/source/TMC2208Stepper.cpp

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TMC2208Stepper() [1/4]

◆ TMC2208Stepper() [2/4]

◆ TMC2208Stepper() [3/4]

◆ TMC2208Stepper() [4/4]

Member Function Documentation

◆ _sendDatagram()

◆ available()

◆ begin()

◆ beginSerial()

◆ calcCRC()

◆ CHOPCONF() [1/2]

◆ CHOPCONF() [2/2]

◆ cs_actual()

◆ cur_a()

◆ cur_b()

◆ dedge() [1/2]

◆ dedge() [2/2]

◆ defaults()

◆ diag()

◆ dir()

◆ diss2g() [1/2]

◆ diss2g() [2/2]

◆ diss2vs() [1/2]

◆ diss2vs() [2/2]

◆ DRV_STATUS()

◆ en_spreadCycle() [1/2]

◆ en_spreadCycle() [2/2]

◆ enn()

◆ FACTORY_CONF() [1/2]

◆ FACTORY_CONF() [2/2]

◆ fclktrim() [1/2]

◆ fclktrim() [2/2]

◆ freewheel() [1/2]

◆ freewheel() [2/2]

◆ GCONF() [1/2]

◆ GCONF() [2/2]

◆ hend() [1/2]

◆ hend() [2/2]

◆ hstrt() [1/2]

◆ hstrt() [2/2]

◆ I_scale_analog() [1/2]

◆ I_scale_analog() [2/2]

◆ IFCNT()

◆ index_otpw() [1/2]

◆ index_otpw() [2/2]

◆ index_step() [1/2]

◆ index_step() [2/2]

◆ INIT2208_REGISTER() [1/4]

◆ INIT2208_REGISTER() [2/4]

◆ INIT2208_REGISTER() [3/4]

◆ INIT2208_REGISTER() [4/4]

◆ INIT_REGISTER() [1/2]

◆ INIT_REGISTER() [2/2]

◆ internal_Rsense() [1/2]

◆ internal_Rsense() [2/2]

◆ intpol() [1/2]

◆ intpol() [2/2]

◆ IOIN()

◆ isEnabled()

◆ mres() [1/2]

◆ mres() [2/2]

◆ ms1()

◆ ms2()

◆ MSCURACT()

◆ mstep_reg_select() [1/2]

◆ mstep_reg_select() [2/2]

◆ multistep_filt() [1/2]

◆ multistep_filt() [2/2]

◆ ola()

◆ olb()

◆ ot()

◆ OTP_PROG()