Skip to content
Registration NameClass NamePackage
ActivateControllerauto_apms_ros2control::SwitchControllerauto_apms_ros2control
CheckControllerStateauto_apms_ros2control::CheckControllerStateauto_apms_ros2control
CheckHardwareStateauto_apms_ros2control::CheckHardwareStateauto_apms_ros2control
CleanupControllerauto_apms_ros2control::CleanupControllerauto_apms_ros2control
ConfigureControllerauto_apms_ros2control::ConfigureControllerauto_apms_ros2control
DeactivateControllerauto_apms_ros2control::SwitchControllerauto_apms_ros2control
ListControllerTypesauto_apms_ros2control::ListControllerTypesauto_apms_ros2control
ListControllersauto_apms_ros2control::ListControllersauto_apms_ros2control
ListHardwareComponentsauto_apms_ros2control::ListHardwareComponentsauto_apms_ros2control
ListHardwareInterfacesauto_apms_ros2control::ListHardwareInterfacesauto_apms_ros2control
LoadControllerauto_apms_ros2control::LoadControllerauto_apms_ros2control
ReloadControllerLibrariesauto_apms_ros2control::ReloadControllerLibrariesauto_apms_ros2control
SetHardwareComponentStateauto_apms_ros2control::SetHardwareComponentStateauto_apms_ros2control
SwitchControllerauto_apms_ros2control::SwitchControllerauto_apms_ros2control
UnloadControllerauto_apms_ros2control::UnloadControllerauto_apms_ros2control

auto_apms_ros2control

ActivateController

Plugin Class: auto_apms_ros2control::SwitchController

C++ Model: auto_apms_ros2control::ActivateController

Node Type: Action

Description: Activates a single ros2_control controller

Input Ports

Input NameTypeDefault ValueDescription
strictnessstd::stringSTRICTSwitching behavior on error. One of: BEST_EFFORT, STRICT, AUTO, FORCE_AUTO.
activate_controllersstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >';'-separated names of the controllers to activate.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
messagestd::stringService response: informational message.

CheckControllerState

Plugin Class: auto_apms_ros2control::CheckControllerState

C++ Model: auto_apms_ros2control::CheckControllerState

Node Type: Action

Description: Checks the current state of a single controller loaded by the controller manager

Input Ports

Input NameTypeDefault ValueDescription
statestd::stringExpected state of the controller (e.g. active, inactive, unconfigured). If empty, only the existence of the controller is checked.
controllerstd::stringName of the controller to check.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
current_statestd::stringCurrent state of the controller.

CheckHardwareState

Plugin Class: auto_apms_ros2control::CheckHardwareState

C++ Model: auto_apms_ros2control::CheckHardwareState

Node Type: Action

Description: Checks the current lifecycle state of a single hardware component loaded by the controller manager

Input Ports

Input NameTypeDefault ValueDescription
statestd::stringExpected lifecycle state of the hardware component (e.g. active, inactive, unconfigured, finalized). If empty, only the existence of the component is checked.
hardwarestd::stringName of the hardware component to check.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
current_statestd::stringCurrent lifecycle state label of the hardware component.

CleanupController

Plugin Class: auto_apms_ros2control::CleanupController

C++ Model: auto_apms_ros2control::CleanupController

Node Type: Action

Description: Cleans up an inactive controller (transition back to the 'unconfigured' state)

Input Ports

Input NameTypeDefault ValueDescription
controllerstd::stringName of the targeted controller.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

ConfigureController

Plugin Class: auto_apms_ros2control::ConfigureController

C++ Model: auto_apms_ros2control::ConfigureController

Node Type: Action

Description: Configures a loaded controller (transition to the 'inactive' state)

Input Ports

Input NameTypeDefault ValueDescription
controllerstd::stringName of the targeted controller.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

DeactivateController

Plugin Class: auto_apms_ros2control::SwitchController

C++ Model: auto_apms_ros2control::DeactivateController

Node Type: Action

Description: Deactivates a single ros2_control controller

Input Ports

Input NameTypeDefault ValueDescription
strictnessstd::stringSTRICTSwitching behavior on error. One of: BEST_EFFORT, STRICT, AUTO, FORCE_AUTO.
deactivate_controllersstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >';'-separated names of the controllers to deactivate.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
messagestd::stringService response: informational message.

ListControllerTypes

Plugin Class: auto_apms_ros2control::ListControllerTypes

C++ Model: auto_apms_ros2control::ListControllerTypes

Node Type: Action

Description: Queries all controller types the controller manager is able to load

Input Ports

Input NameTypeDefault ValueDescription
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
base_classesstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Base classes of the available controller types (aligned with 'types').
typesstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all available controller types.

ListControllers

Plugin Class: auto_apms_ros2control::ListControllers

C++ Model: auto_apms_ros2control::ListControllers

Node Type: Action

Description: Queries the names and states of all controllers loaded by the controller manager

Input Ports

Input NameTypeDefault ValueDescription
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
inactive_controllersstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all inactive controllers.
active_controllersstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all active controllers.
controllersstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all loaded controllers.

ListHardwareComponents

Plugin Class: auto_apms_ros2control::ListHardwareComponents

C++ Model: auto_apms_ros2control::ListHardwareComponents

Node Type: Action

Description: Queries the names and lifecycle states of all hardware components loaded by the controller manager

Input Ports

Input NameTypeDefault ValueDescription
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
inactive_componentsstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all inactive hardware components.
active_componentsstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all active hardware components.
componentsstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all loaded hardware components.

ListHardwareInterfaces

Plugin Class: auto_apms_ros2control::ListHardwareInterfaces

C++ Model: auto_apms_ros2control::ListHardwareInterfaces

Node Type: Action

Description: Queries the names of all command and state interfaces registered with the controller manager

Input Ports

Input NameTypeDefault ValueDescription
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
claimed_command_interfacesstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all currently claimed command interfaces.
available_command_interfacesstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all currently available command interfaces.
state_interfacesstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all state interfaces.
command_interfacesstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >Names of all command interfaces.

LoadController

Plugin Class: auto_apms_ros2control::LoadController

C++ Model: auto_apms_ros2control::LoadController

Node Type: Action

Description: Loads a controller into the controller manager

Input Ports

Input NameTypeDefault ValueDescription
controllerstd::stringName of the targeted controller.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

ReloadControllerLibraries

Plugin Class: auto_apms_ros2control::ReloadControllerLibraries

C++ Model: auto_apms_ros2control::ReloadControllerLibraries

Node Type: Action

Description: Reloads all available controller libraries of the controller manager

Input Ports

Input NameTypeDefault ValueDescription
force_killboolfalseUnload all loaded controllers before reloading the libraries.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

SetHardwareComponentState

Plugin Class: auto_apms_ros2control::SetHardwareComponentState

C++ Model: auto_apms_ros2control::SetHardwareComponentState

Node Type: Action

Description: Sets the lifecycle state of a hardware component loaded by the controller manager

Input Ports

Input NameTypeDefault ValueDescription
target_statestd::stringTarget lifecycle state. One of: unconfigured, inactive, active, finalized.
componentstd::stringName of the targeted hardware component.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
statestd::stringLabel of the hardware component's resulting lifecycle state.

SwitchController

Plugin Class: auto_apms_ros2control::SwitchController

C++ Model: auto_apms_ros2control::SwitchController

Node Type: Action

Description: Activates and/or deactivates one or more ros2_control controllers in one controller manager update cycle

Input Ports

Input NameTypeDefault ValueDescription
timeoutdouble0.000000Timeout [s] before aborting pending controllers (0 = infinite).
activate_asapboolfalseActivate the controllers as soon as their hardware dependencies are ready instead of waiting for all interfaces to become available.
strictnessstd::stringSTRICTSwitching behavior on error. One of: BEST_EFFORT, STRICT, AUTO, FORCE_AUTO.
deactivate_controllersstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >';'-separated names of the controllers to deactivate.
activate_controllersstd::vector<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >, std::allocator<std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > > >';'-separated names of the controllers to activate.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Output Ports

Output NameTypeDefault ValueDescription
messagestd::stringService response: informational message.

UnloadController

Plugin Class: auto_apms_ros2control::UnloadController

C++ Model: auto_apms_ros2control::UnloadController

Node Type: Action

Description: Unloads a controller from the controller manager

Input Ports

Input NameTypeDefault ValueDescription
controllerstd::stringName of the targeted controller.
controller_managerstd::stringcontroller_managerName of the targeted controller manager.

Released under the Apache-2.0 License.