adi_tmcl
C++ API
Class Hierarchy
File Hierarchy
Full C++ API
Classes and Structs
Struct tmcl_cfg_t
Struct tmcl_msg_t
Class BldcMotor
Class Motor
Class SocketCAN
Class StepperMotor
Class TmclInterpreter
Class TmclRos2
Enums
Enum tmcl_additional_ratio_params_lut_t
Enum tmcl_bldc_comm_mode_t
Enum tmcl_cmd_t
Enum tmcl_custom_cmd_lut_t
Enum tmcl_general_params_lut_t
Enum tmcl_hardware_params_lut_t
Enum tmcl_interface_params_lut_t
Enum tmcl_interface_t
Enum tmcl_ros_topic_params_lut_t
Enum tmcl_stepper_mode_t
Enum tmcl_sts_t
Variables
Variable additional_ratio_params_
Variable ANGULAR_FULL_ROTATION
Variable AUTO_START_ADDITIONAL_DELAY_DEFAULT
Variable AUTO_START_ADDITIONAL_DELAY_MAX
Variable comm_interface_params_
Variable EXEC_CMD_RETRIES_DEFAULT
Variable EXEC_CMD_RETRIES_MAX
Variable general_params_
Variable hardware_params_
Variable PI
Variable PUB_RATE_DEFAULT
Variable PUB_RATE_MAX
Variable PUB_RATE_MIN
Variable ros_topic_params_
Variable RX_ID_DEFAULT
Variable SEC_TO_MIN
Variable TIMEOUT_MS_DEFAULT
Variable TIMEOUT_MS_MAX
Variable TIMEOUT_MS_MIN
Variable tmcl_custom_cmd_
Variable TMCL_MSG_SZ
Variable TMCL_MSG_VALUE_SZ
Variable TMCM_BLDC
Variable TX_ID_DEFAULT
Variable TXRX_ID_MAX
Variable TXRX_ID_MIN
Directories
Directory include
Directory adi_tmcl
Files
File socket_can_wrapper.hpp
File tmcl_bldc_motor.hpp
File tmcl_common.hpp
File tmcl_interpreter.hpp
File tmcl_motor.hpp
File tmcl_ros2.hpp
File tmcl_stepper_motor.hpp
Message Definitions
TmcInfo
TmcParam
Service Definitions
TmcCustomCmd
TmcGapAll
TmcGgpAll
Standard Documents
CHANGELOG
Changelog for package tmcl_ros2
2.0.3 (2024-11-13)
2.0.2 (2024-11-05)
2.0.1 (2024-07-15)
2.0.0 (2023-11-21)
1.0.2 (2023-10-27)
1.0.1 (2023-10-10)
1.0.0 (2023-09-27)
LICENSE
PACKAGE
README
adi_tmcl
Background
Hardware
Software
Software Architecture
Software Dependencies
Clone
Build
Pre-Launch (One-time per setup)
BLDC Motors
Stepper Motors
Pre-Launch (One-time)
Initialize CAN
De-initialize CAN
Launch
Nodes
tmcl_ros2_node
Quick Tests
Test Velocity Mode
Test Position Mode
Test Torque Mode
Limitations
Support
Index
adi_tmcl
Index
Index
A
|
B
|
C
|
E
|
G
|
H
|
M
|
P
|
R
|
S
|
T
A
additional_ratio_params_ (C++ member)
ANGULAR_FULL_ROTATION (C++ member)
AUTO_START_ADDITIONAL_DELAY_DEFAULT (C++ member)
AUTO_START_ADDITIONAL_DELAY_MAX (C++ member)
B
BldcMotor (C++ class)
BldcMotor::BldcMotor (C++ function)
BldcMotor::init (C++ function)
BldcMotor::~BldcMotor (C++ function)
C
comm_interface_params_ (C++ member)
E
EXEC_CMD_RETRIES_DEFAULT (C++ member)
EXEC_CMD_RETRIES_MAX (C++ member)
G
general_params_ (C++ member)
H
hardware_params_ (C++ member)
M
Motor (C++ class)
Motor::cmdTrqSubscriberCallback (C++ function)
Motor::getMotorName (C++ function)
Motor::getMotorNumber (C++ function)
Motor::init (C++ function)
Motor::initMotorParams (C++ function)
Motor::initPublisherParams (C++ function)
Motor::module_number_ (C++ member)
Motor::Motor (C++ function)
Motor::p_node_ (C++ member)
Motor::p_tmcl_interpreter_ (C++ member)
Motor::param_additional_ratio_pos_ (C++ member)
Motor::param_additional_ratio_trq_ (C++ member)
Motor::param_additional_ratio_vel_ (C++ member)
Motor::param_comm_interface_name_ (C++ member)
Motor::param_en_pub_tmc_info_ (C++ member)
Motor::param_pub_actual_pos_ (C++ member)
Motor::param_pub_actual_trq_ (C++ member)
Motor::param_pub_actual_vel_ (C++ member)
Motor::param_pub_rate_tmc_info_ (C++ member)
Motor::param_tmc_cmd_abspos_topic_ (C++ member)
Motor::param_tmc_cmd_relpos_topic_ (C++ member)
Motor::param_tmc_cmd_trq_topic_ (C++ member)
Motor::param_tmc_cmd_vel_topic_ (C++ member)
Motor::param_tmc_info_topic_ (C++ member)
Motor::param_wheel_diameter_ (C++ member)
Motor::publisher_ (C++ member)
Motor::publisher_timer_ (C++ member)
Motor::subscription_cmd_abspos_ (C++ member)
Motor::subscription_cmd_relpos_ (C++ member)
Motor::subscription_cmd_trq_ (C++ member)
Motor::subscription_cmd_vel_ (C++ member)
Motor::tmc_info_frame_id_ (C++ member)
Motor::~Motor (C++ function)
P
PI (C++ member)
PUB_RATE_DEFAULT (C++ member)
PUB_RATE_MAX (C++ member)
PUB_RATE_MIN (C++ member)
R
ros_topic_params_ (C++ member)
RX_ID_DEFAULT (C++ member)
S
SEC_TO_MIN (C++ member)
SocketCAN (C++ class)
SocketCAN::deinitialize (C++ function)
SocketCAN::framesAvailable (C++ function)
SocketCAN::initialize (C++ function)
SocketCAN::readFrame (C++ function)
SocketCAN::SocketCAN (C++ function)
SocketCAN::writeFrame (C++ function)
SocketCAN::~SocketCAN (C++ function)
StepperMotor (C++ class)
StepperMotor::StepperMotor (C++ function)
StepperMotor::~StepperMotor (C++ function)
T
TIMEOUT_MS_DEFAULT (C++ member)
TIMEOUT_MS_MAX (C++ member)
TIMEOUT_MS_MIN (C++ member)
tmcl_additional_ratio_params_lut_t (C++ enum)
tmcl_additional_ratio_params_lut_t::IDX_ADDITIONAL_RATIO_POS (C++ enumerator)
tmcl_additional_ratio_params_lut_t::IDX_ADDITIONAL_RATIO_TRQ (C++ enumerator)
tmcl_additional_ratio_params_lut_t::IDX_ADDITIONAL_RATIO_VEL (C++ enumerator)
tmcl_additional_ratio_params_lut_t::TMCL_ADDITIONAL_RATIO_PARAMS_LUT_MAX (C++ enumerator)
tmcl_bldc_comm_mode_t (C++ enum)
tmcl_bldc_comm_mode_t::BLDC_MODE_CLOSEDLOOP (C++ enumerator)
tmcl_bldc_comm_mode_t::BLDC_MODE_DISABLED (C++ enumerator)
tmcl_bldc_comm_mode_t::BLDC_MODE_OPENLOOP (C++ enumerator)
tmcl_cfg_t (C++ struct)
tmcl_cfg_t::interface_name (C++ member)
tmcl_cfg_t::p_socket_can (C++ member)
tmcl_cfg_t::rx_id (C++ member)
tmcl_cfg_t::tx_id (C++ member)
tmcl_cmd_t (C++ enum)
tmcl_cmd_t::TMCL_CMD_APPGFWV (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_GAP (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_GGP (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_MAX (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_MST (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_MVP (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_ROL (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_ROR (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_SAP (C++ enumerator)
tmcl_cmd_t::TMCL_CMD_SGP (C++ enumerator)
tmcl_custom_cmd_ (C++ member)
tmcl_custom_cmd_lut_t (C++ enum)
tmcl_custom_cmd_lut_t::IDX_GAP (C++ enumerator)
tmcl_custom_cmd_lut_t::IDX_GGP (C++ enumerator)
tmcl_custom_cmd_lut_t::IDX_SAP (C++ enumerator)
tmcl_custom_cmd_lut_t::IDX_SGP (C++ enumerator)
tmcl_general_params_lut_t (C++ enum)
tmcl_general_params_lut_t::IDX_ADHOC_MODE (C++ enumerator)
tmcl_general_params_lut_t::IDX_AUTO_START_ADDITIONAL_DELAY (C++ enumerator)
tmcl_general_params_lut_t::IDX_AXIS_PARAMETERS_NAME (C++ enumerator)
tmcl_general_params_lut_t::IDX_AXIS_PARAMETERS_TYPE (C++ enumerator)
tmcl_general_params_lut_t::IDX_EN_MOTORS (C++ enumerator)
tmcl_general_params_lut_t::IDX_GLOBAL_PARAMETERS_NAME (C++ enumerator)
tmcl_general_params_lut_t::IDX_GLOBAL_PARAMETERS_TYPE (C++ enumerator)
tmcl_general_params_lut_t::TMCL_GENERAL_PARAMS_LUT_MAX (C++ enumerator)
tmcl_hardware_params_lut_t (C++ enum)
tmcl_hardware_params_lut_t::IDX_WHEEL_DIAMETER (C++ enumerator)
tmcl_hardware_params_lut_t::TMCL_HARDWARE_PARAMS_LUT_MAX (C++ enumerator)
tmcl_interface_params_lut_t (C++ enum)
tmcl_interface_params_lut_t::IDX_COMM_EXEC_CMD_RETRIES (C++ enumerator)
tmcl_interface_params_lut_t::IDX_COMM_INTERFACE (C++ enumerator)
tmcl_interface_params_lut_t::IDX_COMM_INTERFACE_NAME (C++ enumerator)
tmcl_interface_params_lut_t::IDX_COMM_RX_ID (C++ enumerator)
tmcl_interface_params_lut_t::IDX_COMM_TIMEOUT_MS (C++ enumerator)
tmcl_interface_params_lut_t::IDX_COMM_TX_ID (C++ enumerator)
tmcl_interface_params_lut_t::TMCL_INTERFACE_PARAMS_LUT_MAX (C++ enumerator)
tmcl_interface_t (C++ enum)
tmcl_interface_t::TMCL_INTERFACE_CAN (C++ enumerator)
tmcl_interface_t::TMCL_INTERFACE_MAX (C++ enumerator)
TMCL_MSG_SZ (C++ member)
tmcl_msg_t (C++ struct)
tmcl_msg_t::cmd (C++ member)
tmcl_msg_t::motor (C++ member)
tmcl_msg_t::rx_id (C++ member)
tmcl_msg_t::sts (C++ member)
tmcl_msg_t::tx_id (C++ member)
tmcl_msg_t::type (C++ member)
tmcl_msg_t::value (C++ member)
TMCL_MSG_VALUE_SZ (C++ member)
tmcl_ros_topic_params_lut_t (C++ enum)
tmcl_ros_topic_params_lut_t::IDX_EN_PUB_TMC_INFO (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_PUB_ACTUAL_POS (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_PUB_ACTUAL_TRQ (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_PUB_ACTUAL_VEL (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_PUB_RATE_TMC_INFO (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_TMC_CMD_ABSPOS_TOPIC (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_TMC_CMD_RELPOS_TOPIC (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_TMC_CMD_TRQ_TOPIC (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_TMC_CMD_VEL_TOPIC (C++ enumerator)
tmcl_ros_topic_params_lut_t::IDX_TMC_INFO_TOPIC (C++ enumerator)
tmcl_ros_topic_params_lut_t::TMCL_ROS_TOPIC_PARAMS_LUT_MAX (C++ enumerator)
tmcl_stepper_mode_t (C++ enum)
tmcl_stepper_mode_t::STEPPER_MODE_CLOSEDLOOP (C++ enumerator)
tmcl_stepper_mode_t::STEPPER_MODE_OPENLOOP (C++ enumerator)
tmcl_sts_t (C++ enum)
tmcl_sts_t::TMCL_STS_CMD_LOADED (C++ enumerator)
tmcl_sts_t::TMCL_STS_ERR_CHKSUM (C++ enumerator)
tmcl_sts_t::TMCL_STS_ERR_CMD (C++ enumerator)
tmcl_sts_t::TMCL_STS_ERR_CMD_NA (C++ enumerator)
tmcl_sts_t::TMCL_STS_ERR_EEPROM_LCK (C++ enumerator)
tmcl_sts_t::TMCL_STS_ERR_NONE (C++ enumerator)
tmcl_sts_t::TMCL_STS_ERR_TYPE (C++ enumerator)
tmcl_sts_t::TMCL_STS_ERR_VAL (C++ enumerator)
tmcl_sts_t::TMCL_STS_MAX (C++ enumerator)
TmclInterpreter (C++ class)
TmclInterpreter::executeCmd (C++ function)
,
[1]
TmclInterpreter::getRetriesExceededStatus (C++ function)
TmclInterpreter::resetInterface (C++ function)
TmclInterpreter::setAp (C++ function)
TmclInterpreter::setGp (C++ function)
TmclInterpreter::shutdownInterface (C++ function)
TmclInterpreter::TmclInterpreter (C++ function)
TmclInterpreter::~TmclInterpreter (C++ function)
TmclRos2 (C++ class)
TmclRos2::deInit (C++ function)
TmclRos2::getRetriesExceededStatus (C++ function)
TmclRos2::init (C++ function)
TmclRos2::TmclRos2 (C++ function)
TmclRos2::~TmclRos2 (C++ function)
TMCM_BLDC (C++ member)
TX_ID_DEFAULT (C++ member)
TXRX_ID_MAX (C++ member)
TXRX_ID_MIN (C++ member)