ros2_control - humble
diffbot_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_2__DIFFBOT_SYSTEM_HPP_
16 #define ROS2_CONTROL_DEMO_EXAMPLE_2__DIFFBOT_SYSTEM_HPP_
17 
18 #include <memory>
19 #include <string>
20 #include <vector>
21 
22 #include "hardware_interface/handle.hpp"
23 #include "hardware_interface/hardware_info.hpp"
24 #include "hardware_interface/system_interface.hpp"
25 #include "hardware_interface/types/hardware_interface_return_values.hpp"
26 #include "rclcpp/clock.hpp"
27 #include "rclcpp/duration.hpp"
28 #include "rclcpp/logger.hpp"
29 #include "rclcpp/macros.hpp"
30 #include "rclcpp/time.hpp"
31 #include "rclcpp_lifecycle/node_interfaces/lifecycle_node_interface.hpp"
32 #include "rclcpp_lifecycle/state.hpp"
33 
34 namespace ros2_control_demo_example_2
35 {
37 {
38 public:
39  RCLCPP_SHARED_PTR_DEFINITIONS(DiffBotSystemHardware);
40 
42  const hardware_interface::HardwareInfo & info) override;
43 
44  std::vector<hardware_interface::StateInterface> export_state_interfaces() override;
45 
46  std::vector<hardware_interface::CommandInterface> export_command_interfaces() override;
47 
49  const rclcpp_lifecycle::State & previous_state) override;
50 
52  const rclcpp_lifecycle::State & previous_state) override;
53 
54  hardware_interface::return_type read(
55  const rclcpp::Time & time, const rclcpp::Duration & period) override;
56 
57  hardware_interface::return_type write(
58  const rclcpp::Time & time, const rclcpp::Duration & period) override;
59 
61 
64  rclcpp::Logger get_logger() const { return *logger_; }
65 
67 
70  rclcpp::Clock::SharedPtr get_clock() const { return clock_; }
71 
72 private:
73  // Parameters for the DiffBot simulation
74  double hw_start_sec_;
75  double hw_stop_sec_;
76 
77  // Objects for logging
78  std::shared_ptr<rclcpp::Logger> logger_;
79  rclcpp::Clock::SharedPtr clock_;
80 
81  // Store the command for the simulated robot
82  std::vector<double> hw_commands_;
83  std::vector<double> hw_positions_;
84  std::vector<double> hw_velocities_;
85 };
86 
87 } // namespace ros2_control_demo_example_2
88 
89 #endif // ROS2_CONTROL_DEMO_EXAMPLE_2__DIFFBOT_SYSTEM_HPP_
Definition: system_interface.hpp:73
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: diffbot_system.cpp:32
std::vector< hardware_interface::CommandInterface > export_command_interfaces() override
Exports all command interfaces for this hardware interface.
Definition: diffbot_system.cpp:119
hardware_interface::return_type read(const rclcpp::Time &time, const rclcpp::Duration &period) override
Read the current state values from the actuator.
Definition: diffbot_system.cpp:178
std::vector< hardware_interface::StateInterface > export_state_interfaces() override
Exports all state interfaces for this hardware interface.
Definition: diffbot_system.cpp:105
hardware_interface::return_type write(const rclcpp::Time &time, const rclcpp::Duration &period) override
Write the current command values to the actuator.
Definition: diffbot_system.cpp:203
rclcpp::Logger get_logger() const
Get the logger of the SystemInterface.
Definition: diffbot_system.hpp:64
rclcpp::Clock::SharedPtr get_clock() const
Get the clock of the SystemInterface.
Definition: diffbot_system.hpp:70
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