maix::ext_dev::tmc2209

maix.ext_dev.tmc2209 module

This is maix::ext_dev::tmc2209 module of MaixCDK.
All of these elements are in namespace maix::ext_dev::tmc2209.

For MaixCDK developer: DO NOT edit this doc file manually, this doc is auto generated!

1. Module#

No module

2. Enum#

3. Variable#

4. Function#

4.1. slide_scan#

Scan and initialize the slide with the given parameters

C++ defination code:

void slide_scan(const char* port, uint8_t addr, long baud, /* Uart init param */
                float step_angle, uint16_t micro_step, float round_mm, /* Motor init param */
                float speed_mm_s, bool dir=true, bool use_internal_sense_resistors=true, uint8_t run_current_per=100,
                uint8_t hold_current_per=100, const std::string conf_save_path="./slide_conf.bin",
                bool force_update=true  /* Driver init param */)

Copy

4.2. slide_test#

Test the slide with the given parameters\nThis function tests the slide by moving it in the specified direction until a stall condition is detected, as defined in the configuration file.

C++ defination code:

void slide_test(const char* port, uint8_t addr, long baud, /* Uart init param */
                float step_angle, uint16_t micro_step, float round_mm, /* Motor init param */
                float speed_mm_s, bool dir=true, bool use_internal_sense_resistors=true, uint8_t run_current_per=100,
                uint8_t hold_current_per=100, const std::string conf_save_path="./slide_conf.bin"/* Driver init param */)

Copy

5. Class#

5.1. Slide#

Slide Class

C++ defination code:

class Slide

Copy

5.1.1. __init__#

Constructor for Slide\nInitializes the Slide object with the specified parameters.

C++ defination code:

Slide(const char* port, uint8_t addr, long baud, /* Uart init param */
            float step_angle, uint16_t micro_step, float round_mm,   /* Motor init param */
            float speed_mm_s=-1, bool use_internal_sense_resistors=true, uint8_t run_current_per=100,
            uint8_t hold_current_per=100, std::string cfg_file_path="" /* Driver init param */)

Copy

5.1.2. load_conf#

Load configuration from a file\nLoads the configuration settings for the slide from the specified file path.

C++ defination code:

void load_conf(std::string path)

Copy

5.1.3. move#

Move the slide by a specified length\nMoves the slide by the specified length at the given speed. Optionally checks for stall conditions.

C++ defination code:

void move(float oft, int speed_mm_s=-1, bool check=true)

Copy

5.1.4. reset#

Reset the slide position\nResets the slide position in the specified direction at the given speed.

C++ defination code:

void reset(bool dir=false, int speed_mm_s=-1)

Copy

5.1.5. stop_default_per#

Get or set the stop default percentage\nRetrieves or sets the stop default percentage. If the parameter is -1, it returns the current setting.

C++ defination code:

int stop_default_per(int per=-1)

Copy

5.1.6. run_current_per#

Get or set the run current percentage\nRetrieves or sets the run current percentage. If the parameter is -1, it returns the current setting.

C++ defination code:

int run_current_per(int per=-1)

Copy

5.1.7. hold_current_per#

Get or set the hold current percentage\nRetrieves or sets the hold current percentage. If the parameter is -1, it returns the current setting.

C++ defination code:

int hold_current_per(int per=-1)

Copy

5.1.8. use_internal_sense_resistors#

Enable or disable internal sense resistors\nEnables or disables the internal sense resistors based on the provided boolean value.

C++ defination code:

void use_internal_sense_resistors(bool b=true)

Copy

5.2. ScrewSlide#

ScrewSlide Class

C++ defination code:

class ScrewSlide

Copy

5.2.1. __init__#

Constructor for ScrewSlide

C++ defination code:

ScrewSlide(const char* port, uint8_t addr, long baud, /* Uart init param */
                float step_angle, uint16_t micro_step, float screw_pitch,   /* Motor init param */
                float speed_mm_s=-1, bool use_internal_sense_resistors=true, uint8_t run_current_per=100,
                uint8_t hold_current_per=100)

Copy

5.2.2. move#

Move the slide by a specified length

C++ defination code:

void move(float oft, int speed_mm_s=-1, std::function<bool(float)> callback=nullptr)

Copy

5.2.3. reset#

Reset the slide position

C++ defination code:

void reset(std::function<bool(void)> callback, bool dir=false, int speed_mm_s=-1)

Copy

5.2.4. run_current_per#

Get or set the run current percentage

C++ defination code:

int run_current_per(int per=-1)

Copy

5.2.5. hold_current_per#

Get or set the hold current percentage

C++ defination code:

int hold_current_per(int per=-1)

Copy

5.2.6. use_internal_sense_resistors#

Enable or disable internal sense resistors

C++ defination code:

void use_internal_sense_resistors(bool b=true)

Copy

1. Module
2. Enum
3. Variable
4. Function
   1. slide_scan
   2. slide_test
5. Class
   1. Slide
      1. __init__
      2. load_conf
      3. move
      4. reset
      5. stop_default_per
      6. run_current_per
      7. hold_current_per
      8. use_internal_sense_resistors
   2. ScrewSlide
      1. __init__
      2. move
      3. reset
      4. run_current_per
      5. hold_current_per
      6. use_internal_sense_resistors