Github source for syntax?

Projects General Guidance
1

I am trying to find out what all of the functions of TMCStepper.h mean, but I can't seem to find any explanation. In the readme, I see keywords listed under things like "KEYWORD 1" and "KEYWORD 2" etc. Where can I locate such documentation? Thanks.

https://github.com/teemuatlut/TMCStepper/tree/master

2

Keywords.txt is explained here Library specification - Arduino CLI

3

Ok that makes sense. So that isn't what I am looking for then. What I want to find is definitions. For example, I want to know what these functions do, among many others. So far, everything I have learned about how this library works is by trial and error, observing if the motor does something different when I change a value. That doesn't work for most of these things though, it seems.

  driver.TCOOLTHRS(tcools);//////(0xFFFFF); // 20bit max
  driver.semin(9);
  driver.semax(5);
  driver.sedn(0b01);
4

Oh I see. I guess there isn't a lot of detailed information for the library, because it is mostly a wrapper for registers in the TMC chip.

So for example, semin() sets the SEMIN value, which is described in https://www.analog.com/media/en/technical-documentation/data-sheets/TMC2130_datasheet_rev1.15.pdf on page 66.

1 Like
5

Thanks! I saw that file but didn't realize it contained what I am looking for. I will dig in.

6

This is a description of a different library, but I find that it explains many of the concepts that TMCstepper uses, including TCOOLTHRS, semin, semax and sedn. Hope it helps

1 Like
7

This topic was automatically closed 180 days after the last reply. New replies are no longer allowed.