forked from ros-controls/ros2_control
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Hardware component interfaces (ros-controls#121)
* Initial version of new package implementing components for controlling the robot. * Add control component interfaces. * Added initial tests for Joint and JointInterface * Extended SensorInterface to work with hardware. Added Example for DummySensor and HW in tests. Added lifecycle management for components #10 * Remove component types since they are not used yet. * Added tests for all interfaces and implemented review comments * Added HardwareInfo as the main structure in the robot's URDF file * Add Hardware and Component base classes and tests. * Split Component and Hardware Infos into two files * Use separated headers for components_info and hardware_info * Style corrections * Add documentation for joint and sensor components * Update hardware_interface/test/test_component_interfaces.cpp * Style corrections * The base classes for Joints and Sensors are implemented * Add more tests to get better coverage * Updated after comments and added helper header * Implementation moved to cpp files * Removed virtual function for checking limits * Use inline functions in helper header and make API-consistent return values * move components into components folder
- Loading branch information
Showing
23 changed files
with
2,294 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
hardware_interface/include/hardware_interface/actuator_hardware.hpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
// Copyright 2020 ros2_control Development Team | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
#ifndef HARDWARE_INTERFACE__ACTUATOR_HARDWARE_HPP_ | ||
#define HARDWARE_INTERFACE__ACTUATOR_HARDWARE_HPP_ | ||
|
||
#include <memory> | ||
|
||
#include "hardware_interface/hardware_info.hpp" | ||
#include "hardware_interface/types/hardware_interface_return_values.hpp" | ||
#include "hardware_interface/types/hardware_interface_status_values.hpp" | ||
#include "hardware_interface/visibility_control.h" | ||
|
||
namespace hardware_interface | ||
{ | ||
|
||
namespace components | ||
{ | ||
class Joint; | ||
} // namespace components | ||
class ActuatorHardwareInterface; | ||
|
||
class ActuatorHardware final | ||
{ | ||
public: | ||
ActuatorHardware() = default; | ||
|
||
explicit ActuatorHardware(std::unique_ptr<ActuatorHardwareInterface> impl); | ||
|
||
~ActuatorHardware() = default; | ||
|
||
return_type configure(const HardwareInfo & actuator_info); | ||
|
||
return_type start(); | ||
|
||
return_type stop(); | ||
|
||
hardware_interface_status get_status() const; | ||
|
||
return_type read_joint(std::shared_ptr<components::Joint> joint); | ||
|
||
return_type write_joint(const std::shared_ptr<components::Joint> joint); | ||
|
||
private: | ||
std::unique_ptr<ActuatorHardwareInterface> impl_; | ||
}; | ||
|
||
} // namespace hardware_interface | ||
#endif // HARDWARE_INTERFACE__ACTUATOR_HARDWARE_HPP_ |
105 changes: 105 additions & 0 deletions
105
hardware_interface/include/hardware_interface/actuator_hardware_interface.hpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
// Copyright 2020 ros2_control Development Team | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
#ifndef HARDWARE_INTERFACE__ACTUATOR_HARDWARE_INTERFACE_HPP_ | ||
#define HARDWARE_INTERFACE__ACTUATOR_HARDWARE_INTERFACE_HPP_ | ||
|
||
#include <memory> | ||
|
||
#include "hardware_interface/components/joint.hpp" | ||
#include "hardware_interface/hardware_info.hpp" | ||
#include "hardware_interface/types/hardware_interface_return_values.hpp" | ||
#include "hardware_interface/types/hardware_interface_status_values.hpp" | ||
#include "hardware_interface/visibility_control.h" | ||
|
||
namespace hardware_interface | ||
{ | ||
|
||
/** | ||
* \brief Virtual Class to implement when integrating a 1 DoF actuator into ros2_control. | ||
* The typical examples are conveyors or motors. | ||
*/ | ||
class ActuatorHardwareInterface | ||
{ | ||
public: | ||
HARDWARE_INTERFACE_PUBLIC | ||
ActuatorHardwareInterface() = default; | ||
|
||
HARDWARE_INTERFACE_PUBLIC | ||
virtual | ||
~ActuatorHardwareInterface() = default; | ||
|
||
/** | ||
* \brief Configuration of the actuator from data parsed from the robot's URDF. | ||
* | ||
* \param actuator_info structure with data from URDF. | ||
* \return return_type::OK if required data are provided and can be parsed, | ||
* return_type::ERROR otherwise. | ||
*/ | ||
HARDWARE_INTERFACE_PUBLIC | ||
virtual | ||
return_type configure(const HardwareInfo & actuator_info) = 0; | ||
|
||
/** | ||
* \brief Start exchange data with the hardware. | ||
* | ||
* \return return_type:OK if everything worked as expected, return_type::ERROR otherwise. | ||
*/ | ||
HARDWARE_INTERFACE_PUBLIC | ||
virtual | ||
return_type start() = 0; | ||
|
||
/** | ||
* \brief Stop exchange data with the hardware. | ||
* | ||
* \return return_type:OK if everything worked as expected, return_type::ERROR otherwise. | ||
*/ | ||
HARDWARE_INTERFACE_PUBLIC | ||
virtual | ||
return_type stop() = 0; | ||
|
||
/** | ||
* \brief Get current state of the system hardware. | ||
* | ||
* \return hardware_interface_status current status. | ||
*/ | ||
HARDWARE_INTERFACE_PUBLIC | ||
virtual | ||
hardware_interface_status get_status() const = 0; | ||
|
||
/** | ||
* \brief Read data fromt the hardware into the joint using "set_state" function of the Joint class. | ||
* This function is always called by the resource manager. | ||
* | ||
* \param joint joint where data from the hardware are stored. | ||
* \return return_type:OK if everything worked as expected, return_type::ERROR otherwise. | ||
*/ | ||
HARDWARE_INTERFACE_PUBLIC | ||
virtual | ||
return_type read_joint(std::shared_ptr<components::Joint> joint) const = 0; | ||
|
||
/** | ||
* \brief Write data from the joint to the hardware using "get_command" function of the Joint class. | ||
* This function is always called by the resource manager. | ||
* | ||
* \param joint the joint from which data are written to the hardware. | ||
* \return return_type:OK if everything worked as expected, return_type::ERROR otherwise. | ||
*/ | ||
HARDWARE_INTERFACE_PUBLIC | ||
virtual | ||
return_type write_joint(const std::shared_ptr<components::Joint> joint) = 0; | ||
}; | ||
|
||
} // namespace hardware_interface | ||
#endif // HARDWARE_INTERFACE__ACTUATOR_HARDWARE_INTERFACE_HPP_ |
63 changes: 63 additions & 0 deletions
63
hardware_interface/include/hardware_interface/components/component_info.hpp
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
// Copyright 2020 ros2_control Development Team | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
#ifndef HARDWARE_INTERFACE__COMPONENTS__COMPONENT_INFO_HPP_ | ||
#define HARDWARE_INTERFACE__COMPONENTS__COMPONENT_INFO_HPP_ | ||
|
||
#include <string> | ||
#include <unordered_map> | ||
#include <vector> | ||
|
||
namespace hardware_interface | ||
{ | ||
namespace components | ||
{ | ||
|
||
/** | ||
* \brief This structure stores information about components defined for a specific hardware | ||
* in robot's URDF. | ||
*/ | ||
struct ComponentInfo | ||
{ | ||
/** | ||
* \brief name of the component. | ||
*/ | ||
std::string name; | ||
/** | ||
* \brief type of the component: sensor or actuator. | ||
*/ | ||
std::string type; | ||
/** | ||
* \brief component's class, which will be dynamically loaded. | ||
*/ | ||
std::string class_type; | ||
/** | ||
* \brief name of the command interfaces that can be set, e.g. "position", "velocity", etc. | ||
* Used by joints. | ||
*/ | ||
std::vector<std::string> command_interfaces; | ||
/** | ||
* \brief name of the state interfaces that can be read, e.g. "position", "velocity", etc. | ||
* Used by Joints and Sensors. | ||
*/ | ||
std::vector<std::string> state_interfaces; | ||
/** | ||
* \brief (optional) key-value pairs of components parameters. | ||
*/ | ||
std::unordered_map<std::string, std::string> parameters; | ||
}; | ||
|
||
} // namespace components | ||
} // namespace hardware_interface | ||
#endif // HARDWARE_INTERFACE__COMPONENTS__COMPONENT_INFO_HPP_ |
Oops, something went wrong.