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/macros.hpp"
31 #include "rclcpp/time.hpp"
32 #include "rclcpp_lifecycle/node_interfaces/lifecycle_node_interface.hpp"
33 #include "rclcpp_lifecycle/state.hpp"
34 
35 namespace ros2_control_demo_example_11
36 {
37 struct JointValue
38 {
39  double position{0.0};
40  double velocity{0.0};
41  double effort{0.0};
42 };
43 
44 struct Joint
45 {
46  explicit Joint(const std::string & name) : joint_name(name)
47  {
48  state = JointValue();
49  command = JointValue();
50  }
51 
52  Joint() = default;
53 
54  std::string joint_name;
55  JointValue state;
56  JointValue command;
57 };
59 {
60 public:
61  RCLCPP_SHARED_PTR_DEFINITIONS(CarlikeBotSystemHardware);
62 
64  const hardware_interface::HardwareInfo & info) override;
65 
66  std::vector<hardware_interface::StateInterface> export_state_interfaces() override;
67 
68  std::vector<hardware_interface::CommandInterface> export_command_interfaces() override;
69 
71  const rclcpp_lifecycle::State & previous_state) override;
72 
74  const rclcpp_lifecycle::State & previous_state) override;
75 
76  hardware_interface::return_type read(
77  const rclcpp::Time & time, const rclcpp::Duration & period) override;
78 
79  hardware_interface::return_type write(
80  const rclcpp::Time & time, const rclcpp::Duration & period) override;
81 
82 private:
83  // Parameters for the CarlikeBot simulation
84  double hw_start_sec_;
85  double hw_stop_sec_;
86 
87  // std::vector<std::tuple<std::string, double, double>>
88  // hw_interfaces_; // name of joint, state, command
89  std::map<std::string, Joint> hw_interfaces_;
90 };
91 
92 } // namespace ros2_control_demo_example_11
93 
94 #endif // ROS2_CONTROL_DEMO_EXAMPLE_11__CARLIKEBOT_SYSTEM_HPP_
Definition: system_interface.hpp:73
Definition: carlikebot_system.hpp:59
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:304
std::vector< hardware_interface::CommandInterface > export_command_interfaces() override
Exports all command interfaces for this hardware interface.
Definition: carlikebot_system.cpp:195
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:280
std::vector< hardware_interface::StateInterface > export_state_interfaces() override
Exports all state interfaces for this hardware interface.
Definition: carlikebot_system.cpp:164
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:29
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:38
Definition: carlikebot_system.hpp:45