Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Function aliases that use TMC2209 datasheet parameter names #68

Open
LenStruttmann opened this issue May 25, 2024 · 3 comments

Comments

@LenStruttmann
Copy link

Admittedly, I am somewhat of a newbie, but one of the most difficult problems that I have using your wonderful library is tying the parameter names with your extended function names. For example, using the TCM2209 datasheet I see that I must set TCOOLTHRS. But, how to do that? I need to search through TMC2209.cpp and finally find that the function is setCoolStepDurationThreshold(). For me, my eyes just glaze over when I see such a big glob of characters and I find it nearly impossible to remember that setCoolStepDurationThreshold equates to TCOOLTHRS. It would help me (and I suppose many others) if there was a function
void TCOOLTHRS(uint32_t duration_threshold) to set the value.

Similarly, for values that can be read, a simple function like
uint32_t TSTEP() is, to me, much easier to tie into the datasheet than getInterstepDuration().

Thanks for all that you do.

@aagum-bae
Copy link

Hi strut, if and until this is implemented, you can rename the functions yourelf and use.

@LenStruttmann
Copy link
Author

That is my plan, thanks!

@peterpolidoro
Copy link
Member

I am thinking of doing a pretty major rewrite, so I will definitely keep this in mind, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants