Flexiv RDK APIs  1.5
intermediate2_realtime_joint_impedance_control.cpp
1 
8 #include <flexiv/rdk/robot.hpp>
10 #include <flexiv/rdk/utility.hpp>
11 #include <spdlog/spdlog.h>
12 
13 #include <iostream>
14 #include <string>
15 #include <cmath>
16 #include <thread>
17 #include <atomic>
18 
19 using namespace flexiv;
20 
21 namespace {
23 constexpr double kLoopPeriod = 0.001;
24 
26 constexpr double kSineAmp = 0.035;
27 constexpr double kSineFreq = 0.3;
28 
30 std::atomic<bool> g_stop_sched = {false};
31 }
32 
34 void PrintHelp()
35 {
36  // clang-format off
37  std::cout << "Required arguments: [robot SN]" << std::endl;
38  std::cout << " robot SN: Serial number of the robot to connect to. "
39  "Remove any space, for example: Rizon4s-123456" << std::endl;
40  std::cout << "Optional arguments: [--hold]" << std::endl;
41  std::cout << " --hold: robot holds current joint positions, otherwise do a sine-sweep" << std::endl;
42  std::cout << std::endl;
43  // clang-format on
44 }
45 
47 void PeriodicTask(
48  rdk::Robot& robot, const std::string& motion_type, const std::vector<double>& init_pos)
49 {
50  // Local periodic loop counter
51  static unsigned int loop_counter = 0;
52 
53  try {
54  // Monitor fault on the connected robot
55  if (robot.fault()) {
56  throw std::runtime_error(
57  "PeriodicTask: Fault occurred on the connected robot, exiting ...");
58  }
59 
60  // Initialize target vectors to hold position
61  std::vector<double> target_pos(robot.info().DoF);
62  std::vector<double> target_vel(robot.info().DoF);
63  std::vector<double> target_acc(robot.info().DoF);
64 
65  // Set target vectors based on motion type
66  if (motion_type == "hold") {
67  target_pos = init_pos;
68  } else if (motion_type == "sine-sweep") {
69  for (size_t i = 0; i < target_pos.size(); ++i) {
70  target_pos[i] = init_pos[i]
71  + kSineAmp * sin(2 * M_PI * kSineFreq * loop_counter * kLoopPeriod);
72  }
73  } else {
74  throw std::invalid_argument(
75  "PeriodicTask: Unknown motion type. Accepted motion types: hold, sine-sweep");
76  }
77 
78  // Reduce stiffness to half of nominal values after 5 seconds
79  if (loop_counter == 5000) {
80  auto new_Kq = robot.info().K_q_nom;
81  for (auto& v : new_Kq) {
82  v *= 0.5;
83  }
84  robot.SetJointImpedance(new_Kq);
85  spdlog::info("Joint stiffness set to [{}]", rdk::utility::Vec2Str(new_Kq));
86  }
87 
88  // Reset impedance properties to nominal values after another 5 seconds
89  if (loop_counter == 10000) {
90  robot.SetJointImpedance(robot.info().K_q_nom);
91  spdlog::info("Joint impedance properties are reset");
92  }
93 
94  // Send commands
95  robot.StreamJointPosition(target_pos, target_vel, target_acc);
96 
97  // Increment loop counter
98  loop_counter++;
99 
100  } catch (const std::exception& e) {
101  spdlog::error(e.what());
102  g_stop_sched = true;
103  }
104 }
105 
106 int main(int argc, char* argv[])
107 {
108  // Program Setup
109  // =============================================================================================
110  // Parse parameters
111  if (argc < 2 || rdk::utility::ProgramArgsExistAny(argc, argv, {"-h", "--help"})) {
112  PrintHelp();
113  return 1;
114  }
115  // Serial number of the robot to connect to. Remove any space, for example: Rizon4s-123456
116  std::string robot_sn = argv[1];
117 
118  // Print description
119  spdlog::info(
120  ">>> Tutorial description <<<\nThis tutorial runs real-time joint impedance control to "
121  "hold or sine-sweep all robot joints.\n");
122 
123  // Type of motion specified by user
124  std::string motion_type = "";
125  if (rdk::utility::ProgramArgsExist(argc, argv, "--hold")) {
126  spdlog::info("Robot holding current pose");
127  motion_type = "hold";
128  } else {
129  spdlog::info("Robot running joint sine-sweep");
130  motion_type = "sine-sweep";
131  }
132 
133  try {
134  // RDK Initialization
135  // =========================================================================================
136  // Instantiate robot interface
137  rdk::Robot robot(robot_sn);
138 
139  // Clear fault on the connected robot if any
140  if (robot.fault()) {
141  spdlog::warn("Fault occurred on the connected robot, trying to clear ...");
142  // Try to clear the fault
143  if (!robot.ClearFault()) {
144  spdlog::error("Fault cannot be cleared, exiting ...");
145  return 1;
146  }
147  spdlog::info("Fault on the connected robot is cleared");
148  }
149 
150  // Enable the robot, make sure the E-stop is released before enabling
151  spdlog::info("Enabling robot ...");
152  robot.Enable();
153 
154  // Wait for the robot to become operational
155  while (!robot.operational()) {
156  std::this_thread::sleep_for(std::chrono::seconds(1));
157  }
158  spdlog::info("Robot is now operational");
159 
160  // Move robot to home pose
161  spdlog::info("Moving to home pose");
162  robot.SwitchMode(rdk::Mode::NRT_PLAN_EXECUTION);
163  robot.ExecutePlan("PLAN-Home");
164  // Wait for the plan to finish
165  while (robot.busy()) {
166  std::this_thread::sleep_for(std::chrono::seconds(1));
167  }
168 
169  // Real-time Joint Impedance Control
170  // =========================================================================================
171  // Switch to real-time joint impedance control mode
172  robot.SwitchMode(rdk::Mode::RT_JOINT_IMPEDANCE);
173 
174  // Set initial joint positions
175  auto init_pos = robot.states().q;
176  spdlog::info("Initial joint positions set to: {}", rdk::utility::Vec2Str(init_pos));
177 
178  // Create real-time scheduler to run periodic tasks
179  rdk::Scheduler scheduler;
180  // Add periodic task with 1ms interval and highest applicable priority
181  scheduler.AddTask(
182  std::bind(PeriodicTask, std::ref(robot), std::ref(motion_type), std::ref(init_pos)),
183  "HP periodic", 1, scheduler.max_priority());
184  // Start all added tasks
185  scheduler.Start();
186 
187  // Block and wait for signal to stop scheduler tasks
188  while (!g_stop_sched) {
189  std::this_thread::sleep_for(std::chrono::milliseconds(1));
190  }
191  // Received signal to stop scheduler tasks
192  scheduler.Stop();
193 
194  } catch (const std::exception& e) {
195  spdlog::error(e.what());
196  return 1;
197  }
198 
199  return 0;
200 }
Main interface with the robot, containing several function categories and background services.
Definition: robot.hpp:25
void ExecutePlan(unsigned int index, bool continue_exec=false, bool block_until_started=true)
[Blocking] Execute a plan by specifying its index.
const RobotStates states() const
[Non-blocking] Current states data of the robot.
void SetJointImpedance(const std::vector< double > &K_q, const std::vector< double > &Z_q={0.7, 0.7, 0.7, 0.7, 0.7, 0.7, 0.7})
[Blocking] Set impedance properties of the robot's joint motion controller used in the joint impedanc...
const RobotInfo info() const
[Non-blocking] General information about the connected robot.
bool operational(bool verbose=true) const
[Non-blocking] Whether the robot is ready to be operated, which requires the following conditions to ...
void SwitchMode(Mode mode)
[Blocking] Switch to a new control mode and wait until mode transition is finished.
void StreamJointPosition(const std::vector< double > &positions, const std::vector< double > &velocities, const std::vector< double > &accelerations)
[Non-blocking] Continuously stream joint position, velocity, and acceleration command to the robot....
void Enable()
[Blocking] Enable the robot, if E-stop is released and there's no fault, the robot will release brake...
bool fault() const
[Non-blocking] Whether the robot is in fault state.
bool ClearFault(unsigned int timeout_sec=30)
[Blocking] Try to clear minor or critical fault of the robot without a power cycle.
bool busy() const
[Non-blocking] Whether the robot is currently executing a task. This includes any user commanded oper...
Real-time scheduler that can simultaneously run multiple periodic tasks. Parameters for each task are...
Definition: scheduler.hpp:22
int max_priority() const
[Non-blocking] Get maximum available priority for user tasks.
void AddTask(std::function< void(void)> &&callback, const std::string &task_name, int interval, int priority, int cpu_affinity=-1)
[Non-blocking] Add a new periodic task to the scheduler's task pool. Each task in the pool is assigne...
void Stop()
[Blocking] Stop all added tasks. The periodic execution will stop and all task threads will be closed...
void Start()
[Blocking] Start all added tasks. A dedicated thread will be created for each added task and the peri...
std::vector< double > K_q_nom
Definition: data.hpp:97
std::vector< double > q
Definition: data.hpp:136