ros2_control - humble
carlikebot_system.hpp
1 // Copyright 2021 ros2_control Development Team
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef ROS2_CONTROL_DEMO_EXAMPLE_11__CARLIKEBOT_SYSTEM_HPP_
16 #define ROS2_CONTROL_DEMO_EXAMPLE_11__CARLIKEBOT_SYSTEM_HPP_
17 
18 #include <map>
19 #include <memory>
20 #include <string>
21 #include <utility>
22 #include <vector>
23 
24 #include "hardware_interface/handle.hpp"
25 #include "hardware_interface/hardware_info.hpp"
26 #include "hardware_interface/system_interface.hpp"
27 #include "hardware_interface/types/hardware_interface_return_values.hpp"
28 #include "rclcpp/clock.hpp"
29 #include "rclcpp/duration.hpp"
30 #include "rclcpp/logger.hpp"
31 #include "rclcpp/macros.hpp"
32 #include "rclcpp/time.hpp"
33 #include "rclcpp_lifecycle/node_interfaces/lifecycle_node_interface.hpp"
34 #include "rclcpp_lifecycle/state.hpp"
35 
36 namespace ros2_control_demo_example_11
37 {
38 struct JointValue
39 {
40  double position{0.0};
41  double velocity{0.0};
42  double effort{0.0};
43 };
44 
45 struct Joint
46 {
47  explicit Joint(const std::string & name) : joint_name(name)
48  {
49  state = JointValue();
50  command = JointValue();
51  }
52 
53  Joint() = default;
54 
55  std::string joint_name;
56  JointValue state;
57  JointValue command;
58 };
60 {
61 public:
62  RCLCPP_SHARED_PTR_DEFINITIONS(CarlikeBotSystemHardware);
63 
65  const hardware_interface::HardwareInfo & info) override;
66 
67  std::vector<hardware_interface::StateInterface> export_state_interfaces() override;
68 
69  std::vector<hardware_interface::CommandInterface> export_command_interfaces() override;
70 
72  const rclcpp_lifecycle::State & previous_state) override;
73 
75  const rclcpp_lifecycle::State & previous_state) override;
76 
77  hardware_interface::return_type read(
78  const rclcpp::Time & time, const rclcpp::Duration & period) override;
79 
80  hardware_interface::return_type write(
81  const rclcpp::Time & time, const rclcpp::Duration & period) override;
82 
84 
87  rclcpp::Logger get_logger() const { return *logger_; }
88 
90 
93  rclcpp::Clock::SharedPtr get_clock() const { return clock_; }
94 
95 private:
96  // Parameters for the CarlikeBot simulation
97  double hw_start_sec_;
98  double hw_stop_sec_;
99 
100  // Objects for logging
101  std::shared_ptr<rclcpp::Logger> logger_;
102  rclcpp::Clock::SharedPtr clock_;
103 
104  // std::vector<std::tuple<std::string, double, double>>
105  // hw_interfaces_; // name of joint, state, command
106  std::map<std::string, Joint> hw_interfaces_;
107 };
108 
109 } // namespace ros2_control_demo_example_11
110 
111 #endif // ROS2_CONTROL_DEMO_EXAMPLE_11__CARLIKEBOT_SYSTEM_HPP_
Definition: system_interface.hpp:73
Definition: carlikebot_system.hpp:60
hardware_interface::return_type write(const rclcpp::Time &time, const rclcpp::Duration &period) override
Write the current command values to the actuator.
Definition: carlikebot_system.cpp:295
std::vector< hardware_interface::CommandInterface > export_command_interfaces() override
Exports all command interfaces for this hardware interface.
Definition: carlikebot_system.cpp:183
rclcpp::Logger get_logger() const
Get the logger of the SystemInterface.
Definition: carlikebot_system.hpp:87
hardware_interface::return_type read(const rclcpp::Time &time, const rclcpp::Duration &period) override
Read the current state values from the actuator.
Definition: carlikebot_system.cpp:263
std::vector< hardware_interface::StateInterface > export_state_interfaces() override
Exports all state interfaces for this hardware interface.
Definition: carlikebot_system.cpp:156
rclcpp::Clock::SharedPtr get_clock() const
Get the clock of the SystemInterface.
Definition: carlikebot_system.hpp:93
hardware_interface::CallbackReturn on_init(const hardware_interface::HardwareInfo &info) override
Initialization of the hardware interface from data parsed from the robot's URDF.
Definition: carlikebot_system.cpp:31
rclcpp_lifecycle::node_interfaces::LifecycleNodeInterface::CallbackReturn CallbackReturn
Virtual Class to implement when integrating a 1 DoF actuator into ros2_control.
Definition: actuator_interface.hpp:69
This structure stores information about hardware defined in a robot's URDF.
Definition: hardware_info.hpp:106
Definition: carlikebot_system.hpp:39
Definition: carlikebot_system.hpp:46