hardware_interface
C++ API
Class Hierarchy
File Hierarchy
Full C++ API
Namespaces
Namespace fake_components
Namespace hardware_interface
Namespace hardware_interface::lifecycle_state_names
Namespace mock_components
Namespace rclcpp_lifecycle
Namespace rclcpp_lifecycle::node_interfaces
Classes and Structs
Struct ActuatorInfo
Struct ComponentInfo
Struct ControllerInfo
Struct HardwareComponentInfo
Struct HardwareInfo
Struct HardwareReadWriteStatus
Struct InterfaceInfo
Struct JointInfo
Struct TransmissionInfo
Struct GenericSystem::MimicJoint
Class Actuator
Class ActuatorInterface
Class AsyncComponentThread
Class CommandInterface
Class LoanedCommandInterface
Class LoanedStateInterface
Class ReadOnlyHandle
Class ReadWriteHandle
Class ResourceManager
Class Sensor
Class SensorInterface
Class StateInterface
Class System
Class SystemInterface
Class GenericSystem
Enums
Enum return_type
Functions
Function hardware_interface::parse_bool
Function hardware_interface::parse_control_resources_from_urdf
Function hardware_interface::stod
Variables
Variable hardware_interface::HW_IF_ACCELERATION
Variable hardware_interface::HW_IF_EFFORT
Variable hardware_interface::HW_IF_POSITION
Variable hardware_interface::HW_IF_VELOCITY
Variable hardware_interface::lifecycle_state_names::ACTIVE
Variable hardware_interface::lifecycle_state_names::FINALIZED
Variable hardware_interface::lifecycle_state_names::INACTIVE
Variable hardware_interface::lifecycle_state_names::UNCONFIGURED
Variable hardware_interface::lifecycle_state_names::UNKNOWN
Variable mock_components::ACCELERATION_INTERFACE_INDEX
Variable mock_components::POSITION_INTERFACE_INDEX
Variable mock_components::VELOCITY_INTERFACE_INDEX
Defines
Define FAKE_COMPONENTS_EXPORT
Define FAKE_COMPONENTS_IMPORT
Define FAKE_COMPONENTS_LOCAL
Define FAKE_COMPONENTS_PUBLIC
Define FAKE_COMPONENTS_PUBLIC_TYPE
Define HARDWARE_INTERFACE_EXPORT
Define HARDWARE_INTERFACE_IMPORT
Define HARDWARE_INTERFACE_LOCAL
Define HARDWARE_INTERFACE_PUBLIC
Define HARDWARE_INTERFACE_PUBLIC_TYPE
Define MOCK_COMPONENTS_EXPORT
Define MOCK_COMPONENTS_IMPORT
Define MOCK_COMPONENTS_LOCAL
Define MOCK_COMPONENTS_PUBLIC
Define MOCK_COMPONENTS_PUBLIC_TYPE
Define THROW_ON_NOT_NULLPTR
Define THROW_ON_NULLPTR
Typedefs
Typedef fake_components::GenericSystem
Typedef hardware_interface::CallbackReturn
Typedef mock_components::CallbackReturn
Typedef mock_components::GenericRobot
Directories
Directory include
Directory fake_components
Directory hardware_interface
Directory types
Directory mock_components
Files
File actuator.hpp
File actuator_interface.hpp
File async_components.hpp
File component_parser.hpp
File controller_info.hpp
File generic_system.hpp
File generic_system.hpp
File handle.hpp
File hardware_component_info.hpp
File hardware_info.hpp
File hardware_interface_return_values.hpp
File hardware_interface_type_values.hpp
File lexical_casts.hpp
File lifecycle_state_names.hpp
File loaned_command_interface.hpp
File loaned_state_interface.hpp
File macros.hpp
File resource_manager.hpp
File sensor.hpp
File sensor_interface.hpp
File system.hpp
File system_interface.hpp
File visibility_control.h
File visibility_control.h
File visibility_control.h
Standard Documents
CHANGELOG
Changelog for package hardware_interface
3.30.0 (2024-11-12)
3.29.0 (2024-11-02)
3.28.1 (2024-09-11)
3.28.0 (2024-08-22)
3.27.0 (2024-07-23)
3.26.0 (2024-07-09)
3.25.0 (2024-04-30)
3.24.0 (2024-03-02)
3.23.0 (2024-02-01)
3.22.1 (2024-01-25)
3.22.0 (2024-01-20)
3.21.2 (2023-12-05)
3.21.1 (2023-11-14)
3.21.0 (2023-11-06)
3.20.0 (2023-10-31)
3.19.1 (2023-10-04)
3.19.0 (2023-10-03)
3.18.0 (2023-08-17)
3.17.0 (2023-08-07)
3.16.0 (2023-07-09)
3.15.0 (2023-06-23)
3.14.0 (2023-06-14)
3.13.0 (2023-05-18)
3.12.2 (2023-04-29)
3.12.1 (2023-04-14)
3.12.0 (2023-04-02)
3.11.0 (2023-03-22)
3.10.0 (2023-03-16)
3.9.1 (2023-03-09)
3.9.0 (2023-02-28)
3.8.0 (2023-02-10)
3.7.0 (2023-01-24)
3.6.0 (2023-01-12)
3.5.1 (2023-01-06)
3.5.0 (2022-12-06)
3.4.0 (2022-11-27)
3.3.0 (2022-11-15)
3.2.0 (2022-10-15)
3.1.0 (2022-10-05)
3.0.0 (2022-09-19)
2.15.0 (2022-09-19)
2.14.0 (2022-09-04)
2.13.0 (2022-08-03)
2.12.1 (2022-07-14)
2.12.0 (2022-07-09)
2.11.0 (2022-07-03)
2.10.0 (2022-06-18)
2.9.0 (2022-05-19)
2.8.0 (2022-05-13)
2.7.0 (2022-04-29)
2.6.0 (2022-04-20)
2.5.0 (2022-03-25)
2.4.0 (2022-02-23)
2.3.0 (2022-02-18)
2.2.0 (2022-01-24)
2.1.0 (2022-01-11)
2.0.0 (2021-12-29)
1.2.0 (2021-11-05)
1.1.0 (2021-10-25)
1.0.0 (2021-09-29)
0.8.0 (2021-08-28)
0.7.1 (2021-06-15)
0.7.0 (2021-06-06)
0.6.1 (2021-05-31)
0.6.0 (2021-05-23)
0.5.0 (2021-05-03)
0.4.0 (2021-04-07)
0.3.0 (2021-03-21)
0.2.1 (2021-03-02)
0.2.0 (2021-02-26)
0.1.6 (2021-02-05)
0.1.5 (2021-02-04)
0.1.4 (2021-02-03)
0.1.3 (2021-01-21)
0.1.2 (2021-01-06)
0.1.1 (2020-12-23)
0.1.0 (2020-12-22)
PACKAGE
README
Overview
Documentation
Different update rates for Hardware Components
Hardware Components
Hardware Interface Types
Writing a Hardware Component
Different Update Rates
ros2_control
hardware interface types
Joint Kinematics for ros2_control
Mock Components
Writing a Hardware Component
Index
hardware_interface
Index
Index
F
|
H
|
M
|
T
F
fake_components::GenericSystem (C++ type)
FAKE_COMPONENTS_EXPORT (C macro)
FAKE_COMPONENTS_IMPORT (C macro)
FAKE_COMPONENTS_LOCAL (C macro)
FAKE_COMPONENTS_PUBLIC (C macro)
FAKE_COMPONENTS_PUBLIC_TYPE (C macro)
H
hardware_interface::Actuator (C++ class)
hardware_interface::Actuator::Actuator (C++ function)
,
[1]
,
[2]
hardware_interface::Actuator::~Actuator (C++ function)
hardware_interface::ActuatorInfo (C++ struct)
hardware_interface::ActuatorInfo::command_interfaces (C++ member)
hardware_interface::ActuatorInfo::mechanical_reduction (C++ member)
hardware_interface::ActuatorInfo::name (C++ member)
hardware_interface::ActuatorInfo::offset (C++ member)
hardware_interface::ActuatorInfo::role (C++ member)
hardware_interface::ActuatorInfo::state_interfaces (C++ member)
hardware_interface::ActuatorInterface (C++ class)
hardware_interface::ActuatorInterface::ActuatorInterface (C++ function)
,
[1]
,
[2]
hardware_interface::ActuatorInterface::export_command_interfaces (C++ function)
hardware_interface::ActuatorInterface::export_state_interfaces (C++ function)
hardware_interface::ActuatorInterface::get_name (C++ function)
hardware_interface::ActuatorInterface::get_state (C++ function)
hardware_interface::ActuatorInterface::info_ (C++ member)
hardware_interface::ActuatorInterface::lifecycle_state_ (C++ member)
hardware_interface::ActuatorInterface::on_init (C++ function)
hardware_interface::ActuatorInterface::perform_command_mode_switch (C++ function)
hardware_interface::ActuatorInterface::prepare_command_mode_switch (C++ function)
hardware_interface::ActuatorInterface::read (C++ function)
hardware_interface::ActuatorInterface::set_state (C++ function)
hardware_interface::ActuatorInterface::write (C++ function)
hardware_interface::ActuatorInterface::~ActuatorInterface (C++ function)
hardware_interface::AsyncComponentThread (C++ class)
hardware_interface::AsyncComponentThread::activate (C++ function)
hardware_interface::AsyncComponentThread::AsyncComponentThread (C++ function)
,
[1]
,
[2]
,
[3]
,
[4]
hardware_interface::AsyncComponentThread::write_and_read (C++ function)
hardware_interface::AsyncComponentThread::~AsyncComponentThread (C++ function)
hardware_interface::CallbackReturn (C++ type)
hardware_interface::CommandInterface (C++ class)
hardware_interface::CommandInterface::CommandInterface (C++ function)
,
[1]
hardware_interface::CommandInterface::ReadWriteHandle (C++ function)
,
[1]
,
[2]
,
[3]
,
[4]
hardware_interface::ComponentInfo (C++ struct)
hardware_interface::ComponentInfo::command_interfaces (C++ member)
hardware_interface::ComponentInfo::name (C++ member)
hardware_interface::ComponentInfo::parameters (C++ member)
hardware_interface::ComponentInfo::state_interfaces (C++ member)
hardware_interface::ComponentInfo::type (C++ member)
hardware_interface::ControllerInfo (C++ struct)
hardware_interface::ControllerInfo::claimed_interfaces (C++ member)
hardware_interface::ControllerInfo::name (C++ member)
hardware_interface::ControllerInfo::parameters_file (C++ member)
hardware_interface::ControllerInfo::type (C++ member)
hardware_interface::HardwareComponentInfo (C++ struct)
hardware_interface::HardwareComponentInfo::command_interfaces (C++ member)
hardware_interface::HardwareComponentInfo::is_async (C++ member)
hardware_interface::HardwareComponentInfo::name (C++ member)
hardware_interface::HardwareComponentInfo::plugin_name (C++ member)
hardware_interface::HardwareComponentInfo::state (C++ member)
hardware_interface::HardwareComponentInfo::state_interfaces (C++ member)
hardware_interface::HardwareComponentInfo::type (C++ member)
hardware_interface::HardwareInfo (C++ struct)
hardware_interface::HardwareInfo::gpios (C++ member)
hardware_interface::HardwareInfo::hardware_parameters (C++ member)
hardware_interface::HardwareInfo::hardware_plugin_name (C++ member)
hardware_interface::HardwareInfo::is_async (C++ member)
hardware_interface::HardwareInfo::joints (C++ member)
hardware_interface::HardwareInfo::name (C++ member)
hardware_interface::HardwareInfo::original_xml (C++ member)
hardware_interface::HardwareInfo::sensors (C++ member)
hardware_interface::HardwareInfo::transmissions (C++ member)
hardware_interface::HardwareInfo::type (C++ member)
hardware_interface::HardwareReadWriteStatus (C++ struct)
hardware_interface::HardwareReadWriteStatus::failed_hardware_names (C++ member)
hardware_interface::HardwareReadWriteStatus::ok (C++ member)
hardware_interface::HW_IF_ACCELERATION (C++ member)
hardware_interface::HW_IF_EFFORT (C++ member)
hardware_interface::HW_IF_POSITION (C++ member)
hardware_interface::HW_IF_VELOCITY (C++ member)
hardware_interface::InterfaceInfo (C++ struct)
hardware_interface::InterfaceInfo::data_type (C++ member)
hardware_interface::InterfaceInfo::initial_value (C++ member)
hardware_interface::InterfaceInfo::max (C++ member)
hardware_interface::InterfaceInfo::min (C++ member)
hardware_interface::InterfaceInfo::name (C++ member)
hardware_interface::InterfaceInfo::size (C++ member)
hardware_interface::JointInfo (C++ struct)
hardware_interface::JointInfo::command_interfaces (C++ member)
hardware_interface::JointInfo::mechanical_reduction (C++ member)
hardware_interface::JointInfo::name (C++ member)
hardware_interface::JointInfo::offset (C++ member)
hardware_interface::JointInfo::role (C++ member)
hardware_interface::JointInfo::state_interfaces (C++ member)
hardware_interface::lifecycle_state_names::ACTIVE (C++ member)
hardware_interface::lifecycle_state_names::FINALIZED (C++ member)
hardware_interface::lifecycle_state_names::INACTIVE (C++ member)
hardware_interface::lifecycle_state_names::UNCONFIGURED (C++ member)
hardware_interface::lifecycle_state_names::UNKNOWN (C++ member)
hardware_interface::LoanedCommandInterface (C++ class)
hardware_interface::LoanedCommandInterface::command_interface_ (C++ member)
hardware_interface::LoanedCommandInterface::Deleter (C++ type)
hardware_interface::LoanedCommandInterface::deleter_ (C++ member)
hardware_interface::LoanedCommandInterface::get_full_name (C++ function)
hardware_interface::LoanedCommandInterface::get_interface_name (C++ function)
hardware_interface::LoanedCommandInterface::get_name (C++ function)
hardware_interface::LoanedCommandInterface::get_prefix_name (C++ function)
hardware_interface::LoanedCommandInterface::get_value (C++ function)
hardware_interface::LoanedCommandInterface::LoanedCommandInterface (C++ function)
,
[1]
,
[2]
,
[3]
hardware_interface::LoanedCommandInterface::set_value (C++ function)
hardware_interface::LoanedCommandInterface::~LoanedCommandInterface (C++ function)
hardware_interface::LoanedStateInterface (C++ class)
hardware_interface::LoanedStateInterface::Deleter (C++ type)
hardware_interface::LoanedStateInterface::deleter_ (C++ member)
hardware_interface::LoanedStateInterface::get_full_name (C++ function)
hardware_interface::LoanedStateInterface::get_interface_name (C++ function)
hardware_interface::LoanedStateInterface::get_name (C++ function)
hardware_interface::LoanedStateInterface::get_prefix_name (C++ function)
hardware_interface::LoanedStateInterface::get_value (C++ function)
hardware_interface::LoanedStateInterface::LoanedStateInterface (C++ function)
,
[1]
,
[2]
,
[3]
hardware_interface::LoanedStateInterface::state_interface_ (C++ member)
hardware_interface::LoanedStateInterface::~LoanedStateInterface (C++ function)
hardware_interface::parse_bool (C++ function)
hardware_interface::ReadOnlyHandle (C++ class)
hardware_interface::ReadOnlyHandle::get_full_name (C++ function)
hardware_interface::ReadOnlyHandle::get_interface_name (C++ function)
hardware_interface::ReadOnlyHandle::get_name (C++ function)
hardware_interface::ReadOnlyHandle::get_prefix_name (C++ function)
hardware_interface::ReadOnlyHandle::get_value (C++ function)
hardware_interface::ReadOnlyHandle::interface_name_ (C++ member)
hardware_interface::ReadOnlyHandle::operator bool (C++ function)
hardware_interface::ReadOnlyHandle::operator= (C++ function)
,
[1]
hardware_interface::ReadOnlyHandle::prefix_name_ (C++ member)
hardware_interface::ReadOnlyHandle::ReadOnlyHandle (C++ function)
,
[1]
,
[2]
,
[3]
,
[4]
hardware_interface::ReadOnlyHandle::value_ptr_ (C++ member)
hardware_interface::ReadOnlyHandle::~ReadOnlyHandle (C++ function)
hardware_interface::ReadWriteHandle (C++ class)
hardware_interface::ReadWriteHandle::operator= (C++ function)
,
[1]
hardware_interface::ReadWriteHandle::ReadWriteHandle (C++ function)
,
[1]
,
[2]
,
[3]
,
[4]
hardware_interface::ReadWriteHandle::set_value (C++ function)
hardware_interface::ReadWriteHandle::~ReadWriteHandle (C++ function)
hardware_interface::ResourceManager (C++ class)
hardware_interface::ResourceManager::actuator_components_size (C++ function)
hardware_interface::ResourceManager::available_command_interfaces (C++ function)
hardware_interface::ResourceManager::available_state_interfaces (C++ function)
hardware_interface::ResourceManager::cache_controller_to_hardware (C++ function)
hardware_interface::ResourceManager::claim_command_interface (C++ function)
hardware_interface::ResourceManager::claim_state_interface (C++ function)
hardware_interface::ResourceManager::command_interface_exists (C++ function)
hardware_interface::ResourceManager::command_interface_is_available (C++ function)
hardware_interface::ResourceManager::command_interface_is_claimed (C++ function)
hardware_interface::ResourceManager::command_interface_keys (C++ function)
hardware_interface::ResourceManager::get_cached_controllers_to_hardware (C++ function)
hardware_interface::ResourceManager::get_components_status (C++ function)
hardware_interface::ResourceManager::get_controller_reference_interface_names (C++ function)
hardware_interface::ResourceManager::import_component (C++ function)
,
[1]
,
[2]
hardware_interface::ResourceManager::import_controller_reference_interfaces (C++ function)
hardware_interface::ResourceManager::is_urdf_already_loaded (C++ function)
hardware_interface::ResourceManager::load_urdf (C++ function)
hardware_interface::ResourceManager::make_controller_reference_interfaces_available (C++ function)
hardware_interface::ResourceManager::make_controller_reference_interfaces_unavailable (C++ function)
hardware_interface::ResourceManager::perform_command_mode_switch (C++ function)
hardware_interface::ResourceManager::prepare_command_mode_switch (C++ function)
hardware_interface::ResourceManager::read (C++ function)
hardware_interface::ResourceManager::remove_controller_reference_interfaces (C++ function)
hardware_interface::ResourceManager::ResourceManager (C++ function)
,
[1]
,
[2]
hardware_interface::ResourceManager::sensor_components_size (C++ function)
hardware_interface::ResourceManager::set_component_state (C++ function)
hardware_interface::ResourceManager::state_interface_exists (C++ function)
hardware_interface::ResourceManager::state_interface_is_available (C++ function)
hardware_interface::ResourceManager::state_interface_keys (C++ function)
hardware_interface::ResourceManager::system_components_size (C++ function)
hardware_interface::ResourceManager::write (C++ function)
hardware_interface::ResourceManager::~ResourceManager (C++ function)
hardware_interface::return_type (C++ enum)
hardware_interface::return_type::DEACTIVATE (C++ enumerator)
hardware_interface::return_type::ERROR (C++ enumerator)
hardware_interface::return_type::OK (C++ enumerator)
hardware_interface::Sensor (C++ class)
hardware_interface::Sensor::Sensor (C++ function)
,
[1]
,
[2]
hardware_interface::Sensor::~Sensor (C++ function)
hardware_interface::SensorInterface (C++ class)
hardware_interface::SensorInterface::export_state_interfaces (C++ function)
hardware_interface::SensorInterface::get_name (C++ function)
hardware_interface::SensorInterface::get_state (C++ function)
hardware_interface::SensorInterface::info_ (C++ member)
hardware_interface::SensorInterface::lifecycle_state_ (C++ member)
hardware_interface::SensorInterface::on_init (C++ function)
hardware_interface::SensorInterface::read (C++ function)
hardware_interface::SensorInterface::SensorInterface (C++ function)
,
[1]
,
[2]
hardware_interface::SensorInterface::set_state (C++ function)
hardware_interface::SensorInterface::~SensorInterface (C++ function)
hardware_interface::StateInterface (C++ class)
hardware_interface::StateInterface::ReadOnlyHandle (C++ function)
,
[1]
,
[2]
,
[3]
,
[4]
hardware_interface::StateInterface::StateInterface (C++ function)
,
[1]
hardware_interface::stod (C++ function)
hardware_interface::System (C++ class)
hardware_interface::System::System (C++ function)
,
[1]
,
[2]
hardware_interface::System::~System (C++ function)
hardware_interface::SystemInterface (C++ class)
hardware_interface::SystemInterface::export_command_interfaces (C++ function)
hardware_interface::SystemInterface::export_state_interfaces (C++ function)
hardware_interface::SystemInterface::get_name (C++ function)
hardware_interface::SystemInterface::get_state (C++ function)
hardware_interface::SystemInterface::info_ (C++ member)
hardware_interface::SystemInterface::lifecycle_state_ (C++ member)
hardware_interface::SystemInterface::on_init (C++ function)
hardware_interface::SystemInterface::perform_command_mode_switch (C++ function)
hardware_interface::SystemInterface::prepare_command_mode_switch (C++ function)
hardware_interface::SystemInterface::read (C++ function)
hardware_interface::SystemInterface::set_state (C++ function)
hardware_interface::SystemInterface::SystemInterface (C++ function)
,
[1]
,
[2]
hardware_interface::SystemInterface::write (C++ function)
hardware_interface::SystemInterface::~SystemInterface (C++ function)
hardware_interface::TransmissionInfo (C++ struct)
hardware_interface::TransmissionInfo::actuators (C++ member)
hardware_interface::TransmissionInfo::joints (C++ member)
hardware_interface::TransmissionInfo::name (C++ member)
hardware_interface::TransmissionInfo::parameters (C++ member)
hardware_interface::TransmissionInfo::type (C++ member)
HARDWARE_INTERFACE_EXPORT (C macro)
HARDWARE_INTERFACE_IMPORT (C macro)
HARDWARE_INTERFACE_LOCAL (C macro)
HARDWARE_INTERFACE_PUBLIC (C macro)
HARDWARE_INTERFACE_PUBLIC_TYPE (C macro)
M
mock_components::ACCELERATION_INTERFACE_INDEX (C++ member)
mock_components::CallbackReturn (C++ type)
mock_components::GenericRobot (C++ type)
mock_components::GenericSystem (C++ class)
mock_components::GenericSystem::export_command_interfaces (C++ function)
mock_components::GenericSystem::export_state_interfaces (C++ function)
mock_components::GenericSystem::gpio_commands_ (C++ member)
mock_components::GenericSystem::gpio_interfaces_ (C++ member)
mock_components::GenericSystem::gpio_mock_commands_ (C++ member)
mock_components::GenericSystem::gpio_states_ (C++ member)
mock_components::GenericSystem::joint_commands_ (C++ member)
mock_components::GenericSystem::joint_states_ (C++ member)
mock_components::GenericSystem::mimic_joints_ (C++ member)
mock_components::GenericSystem::MimicJoint (C++ struct)
,
[1]
mock_components::GenericSystem::MimicJoint::joint_index (C++ member)
,
[1]
mock_components::GenericSystem::MimicJoint::mimicked_joint_index (C++ member)
,
[1]
mock_components::GenericSystem::MimicJoint::multiplier (C++ member)
,
[1]
mock_components::GenericSystem::on_init (C++ function)
mock_components::GenericSystem::other_commands_ (C++ member)
mock_components::GenericSystem::other_interfaces_ (C++ member)
mock_components::GenericSystem::other_states_ (C++ member)
mock_components::GenericSystem::perform_command_mode_switch (C++ function)
mock_components::GenericSystem::prepare_command_mode_switch (C++ function)
mock_components::GenericSystem::read (C++ function)
mock_components::GenericSystem::sensor_interfaces_ (C++ member)
mock_components::GenericSystem::sensor_mock_commands_ (C++ member)
mock_components::GenericSystem::sensor_states_ (C++ member)
mock_components::GenericSystem::standard_interfaces_ (C++ member)
mock_components::GenericSystem::write (C++ function)
mock_components::POSITION_INTERFACE_INDEX (C++ member)
mock_components::VELOCITY_INTERFACE_INDEX (C++ member)
MOCK_COMPONENTS_EXPORT (C macro)
MOCK_COMPONENTS_IMPORT (C macro)
MOCK_COMPONENTS_LOCAL (C macro)
MOCK_COMPONENTS_PUBLIC (C macro)
MOCK_COMPONENTS_PUBLIC_TYPE (C macro)
T
THROW_ON_NOT_NULLPTR (C macro)
THROW_ON_NULLPTR (C macro)