FullAutoTuning Class Reference

#include <full_auto_tuning.h>

Public Member Functions
	FullAutoTuning (uint32_t device_address, Cia402Drive &cia402_drive, ControllerType controller_type)
std::variant< std::tuple< double, double, std::string >, MotionMasterError >	start_full_position_auto_tuning ()
	Start the position full auto-tuning. More...
std::variant< std::tuple< double, double, std::string >, MotionMasterError >	start_full_velocity_auto_tuning ()
	Start the velocity full auto-tuning. More...
void	abort ()
	Stop the currently running auto-tuning procedure. More...
bool	abort_callback ()
	Used for getting the abort command as a callback from Cython. More...
void	progress_callback (int32_t percentage)
	A simple function for calling the progress callback function. More...
void	warning_callback (motionmaster::MotionMasterMessage::Status::FullAutoTuning::Warning::Code warning_code, std::string message)
	A simple function for calling the warning callback function. More...
moodycamel::ReaderWriterQueue< motionmaster::MotionMasterMessage::Status * > &	get_status_message_queue ()
	Get the queue with the pending internal messages. More...

Constructor & Destructor Documentation

FullAutoTuning()

FullAutoTuning::FullAutoTuning	(	uint32_t	device_address,
		Cia402Drive &	cia402_drive,
		ControllerType	controller_type
	)

Member Function Documentation

abort()

void FullAutoTuning::abort

(

)

Stop the currently running auto-tuning procedure.

abort_callback()

bool FullAutoTuning::abort_callback

(

)

Used for getting the abort command as a callback from Cython.

Returns

abort command

get_status_message_queue()

moodycamel::ReaderWriterQueue< motionmaster::MotionMasterMessage::Status * > & FullAutoTuning::get_status_message_queue

(

)

Get the queue with the pending internal messages.

Returns

a reference to the pending messages queue

progress_callback()

void FullAutoTuning::progress_callback

(

int32_t

percentage

)

A simple function for calling the progress callback function.

IMPORTANT: Must be a member function in order to check the validity and to be accessible from Cython

start_full_position_auto_tuning()

std::variant< std::tuple< double, double, std::string >, MotionMasterError > FullAutoTuning::start_full_position_auto_tuning

(

)

Start the position full auto-tuning.

Returns

demanded_st, demanded_zeta, warning message (if any) OR MotionMasterError

start_full_velocity_auto_tuning()

std::variant< std::tuple< double, double, std::string >, MotionMasterError > FullAutoTuning::start_full_velocity_auto_tuning

(

)

Start the velocity full auto-tuning.

Returns

demanded_bw, demanded_zeta, warning message (if any) OR MotionMasterError

warning_callback()

void FullAutoTuning::warning_callback	(	motionmaster::MotionMasterMessage::Status::FullAutoTuning::Warning::Code	warning_code,
		std::string	message
	)

A simple function for calling the warning callback function.

Parameters

warning_code
message

---

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

• apps/motion_master/full_auto_tuning.h
• apps/motion_master/full_auto_tuning.cc