Motion Master
Loading...
Searching...
No Matches
util.h
Go to the documentation of this file.
1#pragma once
2
3#ifdef LINUX_BUILD
4#include "dl_syscalls.h"
5#endif
6
7#include <chrono>
8#include <cmath>
9#include <deque>
10#include <future>
11#include <list>
12#include <nlohmann/json.hpp>
13#include <numeric>
14#include <semver.hpp>
15#include <string>
16#include <thread>
17
18#include "cia402_drive.h"
19#include "motion-master.pb.h"
20#include "notifier.h"
22#include "virtual_device.h"
23
24const char* const HARDWARE_DESCRIPTION_FILENAME = ".hardware_description";
25const char* const STACK_INFO_FILENAME = "stack_info.json";
26const char* const STACK_IMAGE_FILENAME = "stack_image.svg";
27const char* const ESI_FILENAME = "SOMANET_CiA_402.xml";
28const char* const CONFIG_FILENAME = "config.csv";
29const char* const PLANT_MODEL_FILENAME = "plant_model.csv";
30const char* const VARIANT_FILENAME = ".variant";
31
32struct PlantModel {
33 std::vector<double> numerator;
34 std::vector<double> denominator;
35 nlohmann::json to_json() {
36 nlohmann::json j;
37 j["numerator"] = numerator;
38 j["denominator"] = denominator;
39 return j;
40 }
41};
42
43enum class ControllerType { kPiP, kPpi };
44
46
47enum class CirculoType {
53};
54
56 kUndefined = 0,
61};
62
64
65#define JSON_TO_DOUBLE(jx) jx.is_number() ? double(jx) : 0.0
66
67// clang-format off
69 uint8_t vel_lp_type = 1; // 0 - disabled, 1 - 1st order, 2 - 2nd order (0x2021, 1)
70 uint32_t vel_lp_fc = 300; // [Hz] (0x2021, 2)
71 uint8_t pos_lp_type = 1; // 0 - disabled, 1 - 1st order, 2 - 2nd order (0x2022, 1)
72 uint32_t pos_lp_fc = 300; // [Hz] (0x2022, 2)
73 bool notch_en = true; // Enabled / disabled (0x2023, 1)
74 uint16_t notch_fw = 10; // [Hz] (0x2023, 3)
75 uint16_t notch_fc = 1000; // [Hz] (0x2023, 2)
76 int16_t vel_ff_gain = 0; // Permill, 0 - disabled (0x2015, 1)
77 uint16_t vel_ff_fc = 1000; // [Hz] (0x2015, 2)
78 int32_t L = 200; // Inductance, [μH] (0x2003, 4)
79 int32_t R = 300000; // Resistance, [μOhm] (0x2003, 3)
80 uint32_t vdc = 48000; // DC voltage, [mV] (0x6079, 0)
81 double current_ratio = 16384; // ADC conversion factor, [mA / inc] (from BSP file)
82 double tc_kp = 2500; // kp gain from FW v4.x.x, [-] (0x2010, 1)
83 double tc_ki = 40000; // ki gain from FW v4.x.x, [-] (0x2010, 2)
84 uint8_t switch_F = 0; // Switching frequency: 0 - 16kHz, 1 - 32kHz, 2 - 64kHz (0x2010, 9)
85 uint16_t tc_st = 1000; // Torque controller settling time, FW v5.x.x, [us] (0x2010, 10)
86 uint16_t tc_damping = 2000; // Torque controller damping ratio, FW v5.x.x, [permill] (0x2010, 11)
87 std::string software_version = "v4.4.1"; // FW version
88 unsigned int rated_torque; // Motor rated torque, [mNm]
89 double max_vel_noise; // Max value of the pre-recorded encoder noise, [RPM]
90 nlohmann::json to_json() {
91 nlohmann::json j;
92 j["vel_lp_type"] = vel_lp_type;
93 j["vel_lp_fc"] = vel_lp_fc;
94 j["pos_lp_type"] = pos_lp_type;
95 j["pos_lp_fc"] = pos_lp_fc;
96 j["notch_en"] = notch_en;
97 j["notch_fw"] = notch_fw;
98 j["notch_fc"] = notch_fc;
99 j["vel_ff_gain"] = vel_ff_gain;
100 j["vel_ff_fc"] = vel_ff_fc;
101 j["L"] = L;
102 j["R"] = R;
103 j["vdc"] = vdc;
104 j["current_ratio"] = current_ratio;
105 j["tc_kp"] = tc_kp;
106 j["tc_ki"] = tc_ki;
107 j["switch_F"] = switch_F;
108 j["tc_st"] = tc_st;
109 j["tc_damping"] = tc_damping;
110 j["software_version"] = software_version;
111 j["rated_torque"] = rated_torque;
112 j["max_vel_noise"] = max_vel_noise;
113 return j;
114 }
116// clang-format on
117
118typedef struct SystemParametersClass {
119 double time_step = 0.001;
120 uint32_t nominal_torque = 0;
121 uint32_t max_torque_mnm_ = 0;
124
125typedef struct TuningParametersClass {
126 // Chirp parameters
127 double duration_seconds = 5.0;
128 uint16_t torque_amplitude = 500;
129 double start_frequency = 3.0;
130 double end_frequency = 60.0;
131 double cutoff_frequency = 30.0;
132
133 // Position auto-tuning parameters
134 ControllerType controller_type = ControllerType::kPpi;
135 double settling_time = 0.2;
136 double position_damping = 2.0;
137 int16_t alpha_mult = 1;
138 uint8_t order = 4;
139
140 // Velocity auto-tuning parameters
142 float velocity_damping = 0.7f;
143
144 // Tuning sharpness limiter (nominal torque * warn_torque_const)
145 double warn_torque_const = 3.0;
146
147 // Position auto-tuning optimization boundaries
148 double lb = 2.0;
149 double ub = 314.0;
151
153
154typedef enum MotionMasterWarning : unsigned int {
159
160const std::map<MotionMasterWarning, std::string>
162 {WAR_NONE, "No warning!"},
164 "Slave profile: The amplitude is outside of the configured limits - "
165 "using a limit value as the new amplitude!"},
166 {WAR_INTERNAL_LIMIT_REACHED, "Internal limit reached!"}};
167
168const std::map<int32_t, std::string> slave_error_map_ = {
169 {0x2110, "Short circuit/earth leakage (input)"},
170 {0x2120, "Earth leakage (input)"},
171 {0x2121, "Earth leakage phase L1"},
172 {0x2122, "Earth leakage phase L2"},
173 {0x2123, "Earth leakage phase L3"},
174 {0x2130, "Short circuit (input)"},
175 {0x2131, "Short circuit phases L1-L2"},
176 {0x2132, "Short circuit phases L2-L3"},
177 {0x2133, "Short circuit phases L3-L1"},
178 {0x2211, "Internal current no.1"},
179 {0x2212, "Internal current no.2"},
180 {0x2213, "Over-current in ramp function"},
181 {0x2214, "Over-current in the sequence"},
182 {0x2220, "Continuous over current (device internal)"},
183 {0x2221, "Continuous over current no.1"},
184 {0x2222, "Continuous over current no.2"},
185 {0x2230, "Short circuit/earth leakage (device internal)"},
186 {0x2240, "Earth leakage (device internal)"},
187 {0x2250, "Short circuit (device internal)"},
188 {0x2310, "Continuous over current"},
189 {0x2311, "Continuous over current no.1"},
190 {0x2312, "Continuous over current no.2"},
191 {0x2320, "Short circuit/earth leakage (motor-side)"},
192 {0x2330, "Earth leakage (motor-side)"},
193 {0x2331, "Earth leakage phase U"},
194 {0x2332, "Earth leakage phase V"},
195 {0x2333, "Earth leakage phase W"},
196 {0x2340, "Short circuit (motor-side)"},
197 {0x2341, "Short circuit phases U-V"},
198 {0x2342, "Earth leakage phase V-W"},
199 {0x2343, "Earth leakage phase W-U"},
200 {0x2350, "Load level fault (I2t, thermal state)"},
201 {0x2351, "Load level warning (I2t, thermal state)"},
202 {0x3110, "Mains overvoltage"},
203 {0x3111, "Mains overvoltage phase L1"},
204 {0x3112, "Mains overvoltage phase L2"},
205 {0x3113, "Mains overvoltage phase L3"},
206 {0x3120, "Mains undervoltage"},
207 {0x3121, "Mains undervoltage phase L1"},
208 {0x3122, "Mains undervoltage phase L2"},
209 {0x3123, "Mains undervoltage phase L3"},
210 {0x3130, "Phase failure"},
211 {0x3131, "Phase failure L1"},
212 {0x3132, "Phase failure L2"},
213 {0x3133, "Phase failure L3"},
214 {0x3134, "Phase sequence"},
215 {0x3140, "Mains frequency"},
216 {0x3141, "Mains frequency too great"},
217 {0x3142, "Mains frequency too small"},
218 {0x3210, "DC link overvoltage"},
219 {0x3211, "Overvoltage no. 1"},
220 {0x3212, "Overvoltage no. 2"},
221 {0x3220, "DC link undervoltage"},
222 {0x3221, "Undervoltage no. 1"},
223 {0x3222, "Undervoltage no. 2"},
224 {0x3230, "Load error"},
225 {0x3310, "Output overvoltage"},
226 {0x3311, "Output overvoltage phase U"},
227 {0x3312, "Output overvoltage phase V"},
228 {0x3313, "Output overvoltage phase W"},
229 {0x3320, "Armature circuit"},
230 {0x3321, "Armature circuit interrupted"},
231 {0x3330, "Field circuit"},
232 {0x3331, "Field circuit interrupted"},
233 {0x4110, "Excess ambient temperature"},
234 {0x4120, "Too low ambient temperature"},
235 {0x4130, "Temperature supply air"},
236 {0x4140, "Temperature air outlet"},
237 {0x4210, "Excess temperature device"},
238 {0x4220, "Too low temperature device"},
239 {0x4300, "Temperature drive"},
240 {0x4310, "Excess temperature drive"},
241 {0x4320, "Too low temperature drive"},
242 {0x4400, "Temperature supply"},
243 {0x4410, "Excess temperature supply"},
244 {0x4420, "Too low temperature supply"},
245 {0x5100, "Supply"},
246 {0x5110, "Supply low voltage"},
247 {0x5111, "U1 = supply ±15V"},
248 {0x5112, "U2 = supply +24 V"},
249 {0x5113, "U3 = supply +5 V"},
250 {0x5114, "U4 = manufacturer-specific"},
251 {0x5115, "U5 = manufacturer-specific"},
252 {0x5116, "U6 = manufacturer-specific"},
253 {0x5117, "U7 = manufacturer-specific"},
254 {0x5118, "U8 = manufacturer-specific"},
255 {0x5119, "U9 = manufacturer-specific"},
256 {0x5120, "Supply intermediate circuit"},
257 {0x5200, "Control"},
258 {0x5210, "Measurement circuit"},
259 {0x5220, "Computing circuit"},
260 {0x5300, "Operating unit"},
261 {0x5400, "Power section"},
262 {0x5410, "Output stages"},
263 {0x5420, "Chopper"},
264 {0x5430, "Input stages"},
265 {0x5440, "Contacts"},
266 {0x5441, "Contact 1 = manufacturer-specific"},
267 {0x5442, "Contact 2 = manufacturer-specific"},
268 {0x5443, "Contact 3 = manufacturer-specific"},
269 {0x5444, "Contact 4 = manufacturer-specific"},
270 {0x5445, "Contact 5 = manufacturer-specific"},
271 {0x5450, "Fuses"},
272 {0x5451, "S1 = l1"},
273 {0x5452, "S2 = l2"},
274 {0x5453, "S3 = l3"},
275 {0x5454, "S4 = manufacturer-specific"},
276 {0x5455, "S5 = manufacturer-specific"},
277 {0x5456, "S6 = manufacturer-specific"},
278 {0x5457, "S7 = manufacturer-specific"},
279 {0x5458, "S8 = manufacturer-specific"},
280 {0x5459, "S9 = manufacturer-specific"},
281 {0x5500, "Hardware memory"},
282 {0x5510, "RAM"},
283 {0x5520, "ROM/EPROM"},
284 {0x5530, "EEPROM"},
285 {0x6010, "Software reset (watchdog)"},
286 {0x6301, "to 630Fh Data record no. 1 to no. 15"},
287 {0x6310, "Loss of parameters"},
288 {0x6320, "Parameter error"},
289 {0x7100, "Power"},
290 {0x7110, "Brake chopper"},
291 {0x7111, "Failure brake chopper"},
292 {0x7112, "Over current brake chopper"},
293 {0x7113, "Protective circuit brake chopper"},
294 {0x7120, "Motor"},
295 {0x7121, "Motor blocked"},
296 {0x7122, "Motor error or commutation malfunction."},
297 {0x7123, "Motor tilted"},
298 {0x7200, "Measurement circuit"},
299 {0x7300, "Sensor"},
300 {0x7301, "Tacho fault"},
301 {0x7302, "Tacho wrong polarity"},
302 {0x7303, "Resolver 1 fault"},
303 {0x7304, "Resolver 2 fault"},
304 {0x7305, "Incremental encoder 1 fault"},
305 {0x7306, "Incremental encoder 2 fault"},
306 {0x7307, "Incremental encoder 3 fault"},
307 {0x7310, "Speed"},
308 {0x7320, "Position"},
309 {0x7400, "Computation circuit"},
310 {0x7500, "Communication"},
311 {0x7510, "Serial interface no. 1"},
312 {0x7520, "Serial interface no. 2"},
313 {0x7600, "Data storage (external)"},
314 {0x8300, "Torque control"},
315 {0x8311, "Excess torque"},
316 {0x8312, "Difficult start up"},
317 {0x8313, "Standstill torque"},
318 {0x8321, "Insufficient torque"},
319 {0x8331, "Torque fault"},
320 {0x8400, "Velocity speed controller"},
321 {0x8500, "Position controller"},
322 {0x8600, "Positioning controller"},
323 {0x8611, "Following error"},
324 {0x8612, "Reference limit"},
325 {0x8700, "Sync controller"},
326 {0x8800, "Winding controller"},
327 {0x8900, "Process data monitoring"},
328 {0x8A00, "Control"},
329 {0xF001, "Deceleration"},
330 {0xF002, "Sub-synchronous run"},
331 {0xF003, "Stroke operation"},
332 {0xF004, "Control"},
333 {0xFF03, "Warning - Excess temperature device"},
334 {0xFF04, "Pull brake voltage higher than measured on DC bus"},
335 {0xFF05, "Hold brake voltage higher than measured on DC bus"},
336 {0xFF06, "Open circuit: High FET in phase A"},
337 {0xFF07, "Open circuit: Low FET in phase A"},
338 {0xFF08, "Open circuit: High FET in phase B"},
339 {0xFF09, "Open circuit: Low FET in phase B"},
340 {0xFF0A, "Open circuit: High FET in phase C"},
341 {0xFF0B, "Open circuit: Low FET in phase C"},
342 {0xFF0C, "Commutation offset is missing"}};
343
344const std::map<int32_t, std::map<int32_t, int32_t>>
346 {8500, {{01, 20480}, {02, 24576}, {03, 16384}}},
347 {8501, {{01, 8192}, {02, 8192}, {03, 16384}}},
348 {8502, {{01, 20480}, {02, 24576}, {03, 16384}}},
349 {8503, {{01, 8192}, {02, 8192}, {03, 16384}}},
350 {8504, {{01, 20480}, {02, 24576}, {03, 16384}}},
351 {8505, {{01, 8192}, {02, 8192}, {03, 16384}}},
352 {9500, {{00, 32768}, {01, 32768}, {02, 32768}}},
353 {9501, {{01, 81920}, {02, 81920}}},
354 {9502, {{01, 16384}}},
355 {9506, {{01, 32768}}},
356 {9507, {{01, 81920}}},
357 {9508, {{01, 16384}}},
358 {9600, {{01, 32768}}},
359 {9601, {{01, 81920}}},
360 {9602, {{01, 16384}}},
361 {9606, {{01, 32768}}},
362 {9607, {{01, 81920}}},
363 {9608, {{01, 16384}}}};
364
365const std::map<int32_t, std::map<int32_t, int32_t>>
367 {8500, {{01, 40960}, {02, 49152}, {03, 32768}}},
368 {8501, {{01, 16384}, {02, 16384}, {03, 16384}}},
369 {8502, {{01, 40960}, {02, 49152}, {03, 32768}}},
370 {8503, {{01, 16384}, {02, 16384}, {03, 16384}}},
371 {8504, {{01, 40960}, {02, 49152}, {03, 32768}}},
372 {8505, {{01, 16384}, {02, 16384}, {03, 16384}}},
373 {9500, {{00, 32768}, {01, 32768}, {02, 32768}}},
374 {9501, {{01, 81920}, {02, 81920}}},
375 {9502, {{01, 16384}}},
376 {9506, {{01, 32768}}},
377 {9507, {{01, 81920}}},
378 {9508, {{01, 16384}}},
379 {9600, {{01, 32768}}},
380 {9601, {{01, 81920}}},
381 {9602, {{01, 16384}}},
382 {9606, {{01, 32768}}},
383 {9607, {{01, 81920}}},
384 {9608, {{01, 16384}}}};
385
387 kNotFound = 0x00008001,
388 kAccessDenied = 0x00008002,
389 kDiskFull = 0x00008003,
390 kIllegal = 0x00008004,
391 kPacketNumberWrong = 0x00008005,
392 kAlreadyExists = 0x00008006,
393 kNoUser = 0x00008007,
394 kBootstrapOnly = 0x00008008,
395 kNotBootstrap = 0x00008009,
396 kNoRights = 0x0000800a,
397 kProgramError = 0x0000800b
398};
399
408
416std::string get_slave_error_message(int32_t error_code);
417
418#ifdef __linux__
424int32_t set_default_thread_priority();
425
437int32_t set_max_thread_priority();
438#endif
439
448std::string etg1004_unit_string(uint32_t etg1004_unit_value);
449
458int32_t get_pdo_id(uint16_t index, uint8_t subindex,
459 std::map<int32_t, int32_t>& pdo_position_map);
460
466const std::string current_date_time();
467
468#ifdef __linux__
477std::string execute_system_command(const char* cmd);
478#endif
479
488bool abs_compare(float a, float b);
489
498template <typename T>
499bool opposite_signs(const T& a, const T& b) {
500 return ((a ^ b) >> (sizeof(T) * 8 - 1));
501}
502
508void interruptable_wait(size_t seconds);
509
519int32_t wrap_target_position(int32_t target, int32_t max_limit,
520 int32_t min_limit);
521
528
534void unregister_sync_signal(uint32_t signal_id);
535
543uint64_t wait_for_sync_signal(uint32_t signal_id);
551uint64_t wait_for_signal(int signal_fd);
552uint64_t wait_for_signal(uint32_t signal_id);
553
563std::vector<double> linspace(double lb, double ub, size_t n);
564
574
584 const ControllerGains& gains);
585
595 const ControllerGains& gains);
596
607bool check_gains(Cia402Drive& cia402_drive);
608
617bool string_ends_with(const std::string& value, const std::string& ending);
618
626std::vector<uint8_t> read_file_content(const std::string& path);
627
634void set_csv_configuration(VirtualDevice* virtual_device,
635 const std::vector<uint8_t>& csv_data);
636
647uint8_t calculate_crc(const std::vector<uint8_t>& data);
648
657uint32_t random_uint32(uint32_t min = 0, uint32_t max = UINT32_MAX);
658
664unsigned char random_char();
665
673std::string generate_uuid(size_t length);
674
682int32_t limit_int32_target(int64_t target);
683
689std::string run_env_info();
690
699bool validate_sii_data(const std::vector<uint8_t>& content, uint32_t device_id);
700
708bool file_exists(const std::string& path);
709
717std::string string_bytes_to_hex_array_string(const std::string& bytes);
718
728std::string get_firmware_version_string(Cia402Drive& cia402_drive);
729
739semver::version get_firmware_version(Cia402Drive& cia402_drive);
740
750
763 Cia402Drive& cia402_drive);
764
774 ControllerGains gains, uint32_t singleturn_resolution);
775
783CirculoType get_circulo_type(int32_t hardware_id);
784
794bool is_fw_based_on_v5(Cia402Drive& cia402_drive);
795
804bool is_fw_at_least(Cia402Drive& cia402_drive, const std::string& version);
805
814std::vector<uint8_t> zip(const std::string& file_name,
815 std::vector<uint8_t> data);
816
826std::vector<uint8_t> unzip(const std::vector<uint8_t>& data);
827
836uint32_t generate_od_entry_map_key(uint16_t index, uint8_t subindex);
837
846std::list<std::string> get_file_parts(std::list<std::string> file_list,
847 const std::string& file_name);
848
858 uint8_t encoder_ordinal);
859
867template <typename T>
868int32_t find_local_min_index_from_right(std::vector<T>& x) {
869 T min_value = x[x.size() - 1];
870
871 for (int32_t i = x.size() - 2; i >= 0; i--) {
872 if (x[i] <= min_value) {
873 min_value = x[i];
874 } else {
875 return i + 1;
876 }
877 }
878
879 return 1;
880}
881
889template <typename T>
890double compute_mean(const std::vector<T>& numbers) {
891 if (numbers.empty()) {
892 return 0.0;
893 }
894
895 return std::accumulate(numbers.begin(), numbers.end(), 0.0) / numbers.size();
896}
897
905template <typename T>
906double compute_standard_deviation(const std::vector<T>& numbers) {
907 if (numbers.empty()) {
908 return 0.0;
909 }
910
911 double mean = compute_mean(numbers);
912
913 std::vector<double> tmp(numbers.size());
914 std::transform(numbers.begin(), numbers.end(), tmp.begin(),
915 [mean](double x) { return x - mean; });
916
917 double sq_sum = std::inner_product(tmp.begin(), tmp.end(), tmp.begin(), 0.0);
918 return std::sqrt(sq_sum / (numbers.size() - 1));
919}
920
930template <typename T>
931double compute_section_mean(const std::vector<T>& numbers, size_t start,
932 size_t end) {
933 std::vector<T> section(numbers.begin() + start, numbers.begin() + end);
934
935 if (section.empty()) {
936 return 0.0;
937 }
938
939 return std::accumulate(section.begin(), section.end(), 0.0) / section.size();
940}
941
950template <typename T>
951std::vector<T> erase_edge_elements(std::vector<T> v, size_t length) {
952 v.erase(v.begin(), v.begin() + length);
953 v.erase(v.end() - length, v.end());
954 return v;
955}
956
964template <typename R>
965bool is_future_done(std::future<R> const& f) {
966 try {
967 return f.wait_for(std::chrono::seconds(0)) == std::future_status::ready;
968 } catch (std::future_error& e) {
969 return true; // The future is not running since there is an error
970 }
971}
972
980template <typename T>
981auto to_integral(T e) {
982 return static_cast<std::underlying_type_t<T>>(e);
983}
984
993template <typename T>
994static std::vector<T> diff(std::vector<T> vector) {
995 std::vector<T> result;
996 result.reserve(vector.size() - 1);
997
998 for (size_t i = 1; i < vector.size(); i++) {
999 result.push_back(vector[i] - vector[i - 1]);
1000 }
1001
1002 return result;
1003}
1004
1008template <typename... Args>
1009std::string string_format(const std::string& format, Args... args) {
1010 int size_s = std::snprintf(nullptr, 0, format.c_str(), args...) +
1011 1; // Extra space for '\0'
1012 if (size_s <= 0) {
1013 throw std::runtime_error("Error during formatting.");
1014 }
1015 auto size = static_cast<size_t>(size_s);
1016 std::unique_ptr<char[]> buf(new char[size]);
1017 std::snprintf(buf.get(), size, format.c_str(), args...);
1018 return std::string(buf.get(),
1019 buf.get() + size - 1); // We don't want the '\0' inside
1020}
1021
1032 public:
1033 LowPassFilter(uint16_t cutoff_frequency, double ts);
1034
1035 double filter(double value);
1036
1037 private:
1038 std::deque<double> input_data_;
1039 std::deque<double> output_data_;
1040 double fc_, a0_, a1_, a2_, b0_, b1_, b2_;
1041};
1042
1052 public:
1053 HighPassFilter(uint16_t cutoff_frequency, double ts);
1054
1055 double filter(double value);
1056
1057 private:
1058 std::deque<double> input_data_;
1059 std::deque<double> output_data_;
1060 double fc_, a0_, a1_, a2_, a3_, a4_, b0_, b1_, b2_, b3_, b4_;
1061};
1062
1064
1065bool compareStringsCaseInsensitive(const std::string& s1,
1066 const std::string& s2);
std::vector< uint8_t > unzip(const std::vector< uint8_t > &data)
Unzip data containing a single file.
Definition: util.cc:1500
const std::map< int32_t, std::string > slave_error_map_
Definition: util.h:168
ControllerGains get_position_controller_gains(Cia402Drive &cia402_drive)
Get the current position controller gains of a drive.
Definition: util.cc:299
const char *const HARDWARE_DESCRIPTION_FILENAME
Definition: util.h:24
double compute_section_mean(const std::vector< T > &numbers, size_t start, size_t end)
Compute the mean of a section of a given vector of integers.
Definition: util.h:931
ControllerGains convert_auto_tuning_controller_gains(ControllerGains gains, uint32_t singleturn_resolution)
Convert gains to inc pos values and rpm velocity values.
Definition: util.cc:1378
const std::map< int32_t, std::map< int32_t, int32_t > > adc_current_ratio_fw_v4_4_2_map
Definition: util.h:366
uint64_t wait_for_signal(int signal_fd)
Wait for the system signal.
std::string controllerTypeToString(ControllerType ct)
Definition: util.cc:169
uint32_t register_sync_signal()
Register a thread sync signal.
bool string_ends_with(const std::string &value, const std::string &ending)
Check if a string ends with another string.
Definition: util.cc:454
const std::map< int32_t, std::map< int32_t, int32_t > > adc_current_ratio_fw_v4_4_1_map
Definition: util.h:345
std::string generate_uuid(size_t length)
Generate a UUID of a custom length.
Definition: util.cc:631
bool set_velocity_controller_gains(Cia402Drive &cia402_drive, const ControllerGains &gains)
Set the velocity controller gains.
Definition: util.cc:401
semver::version get_firmware_version(Cia402Drive &cia402_drive)
Get the (semver) version of the used firmware.
Definition: util.cc:914
std::string get_slave_error_message(int32_t error_code)
Return the appropriate error message.
Definition: util.cc:57
int32_t find_local_min_index_from_right(std::vector< T > &x)
Find a local minimum (from right) in the supplied vector.
Definition: util.h:868
struct AutoTuningDriveConfigurationClass AutoTuningDriveConfiguration
const char *const STACK_INFO_FILENAME
Definition: util.h:25
bool validate_sii_data(const std::vector< uint8_t > &content, uint32_t device_id)
Validate an SII data before writing.
double compute_mean(const std::vector< T > &numbers)
Compute mean given a vector of numbers.
Definition: util.h:890
bool opposite_signs(const T &a, const T &b)
Check if parameters have opposite signs.
Definition: util.h:499
bool get_plant_model_from_flash(Cia402Drive &cia402_drive, PlantModel *m)
Get the plant model from the flash memory of the device.
Definition: util.cc:961
const char *const ESI_FILENAME
Definition: util.h:27
const std::map< MotionMasterWarning, std::string > motion_master_warning_to_message_map_
Definition: util.h:161
void unregister_sync_signal(uint32_t signal_id)
Unregister a thread sync signal.
int32_t limit_int32_target(int64_t target)
Limit a target to integer 32 if necessary.
Definition: util.cc:643
std::string run_env_info()
Get all sorts of run environment information.
Definition: util.cc:663
const char *const CONFIG_FILENAME
Definition: util.h:28
bool compareStringsCaseInsensitive(const std::string &s1, const std::string &s2)
Definition: util.cc:1703
int32_t wrap_target_position(int32_t target, int32_t max_limit, int32_t min_limit)
Wrap the target position over limit.
std::vector< double > linspace(double lb, double ub, size_t n)
Generate equally spaced points inside an interval.
Definition: util.cc:283
CirculoType
Definition: util.h:47
PositionControlStrategy
Definition: util.h:152
ControllerType
Definition: util.h:43
uint64_t wait_for_sync_signal(uint32_t signal_id)
Wait for the system sync signal.
std::string etg1004_unit_string(uint32_t etg1004_unit_value)
Convert ETG.1004 unit format to string.
Definition: util.cc:93
EncoderLocation
Definition: util.h:63
MotionMasterWarning
Definition: util.h:154
@ WAR_PROFILE_TARGET_LIMITED
Definition: util.h:156
@ WAR_INTERNAL_LIMIT_REACHED
Definition: util.h:157
@ WAR_NONE
Definition: util.h:155
const char *const VARIANT_FILENAME
Definition: util.h:30
std::vector< uint8_t > read_file_content(const std::string &path)
Read a file into a byte (uint8_t) vector.
Definition: util.cc:462
uint8_t calculate_crc(const std::vector< uint8_t > &data)
Definition: util.cc:592
uint32_t generate_od_entry_map_key(uint16_t index, uint8_t subindex)
Generate a map key for an OD entry using index/subindex.
Definition: util.cc:1541
unsigned char random_char()
Generate a random character.
Definition: util.cc:624
std::vector< uint8_t > zip(const std::string &file_name, std::vector< uint8_t > data)
Zip a single file.
Definition: util.cc:1448
bool file_exists(const std::string &path)
Check if a file exists on the system where Motion Master is running.
Definition: util.cc:876
std::string get_master_warning_message(MotionMasterWarning warning)
Return the appropriate warning message.
Definition: util.cc:49
bool set_position_controller_gains(Cia402Drive &cia402_drive, const ControllerGains &gains)
Set the position controller gains.
Definition: util.cc:353
bool check_gains(Cia402Drive &cia402_drive)
Check if the required gains are properly set.
Definition: util.cc:423
CirculoEncoderType
Definition: util.h:55
bool abs_compare(float a, float b)
Compare absolute values of the input parameters.
Definition: util.cc:220
void interruptable_wait(size_t seconds)
Blocks for the set amount of time, but allows to be interrupted.
Definition: util.cc:222
uint32_t random_uint32(uint32_t min=0, uint32_t max=UINT32_MAX)
Generate a random unsigned 32-bit integer in a certain range.
Definition: util.cc:617
double compute_standard_deviation(const std::vector< T > &numbers)
Compute the standard deviation given a vector of numbers.
Definition: util.h:906
std::list< std::string > get_file_parts(std::list< std::string > file_list, const std::string &file_name)
Process the provided file list and find the file or its parts.
Definition: util.cc:1545
std::vector< T > erase_edge_elements(std::vector< T > v, size_t length)
Remove a number of the first and last elements in the vector.
Definition: util.h:951
int get_soem_slaves_responding()
Definition: util.cc:1697
EncoderLocation get_encoder_location(Cia402Drive &cia402_drive, uint8_t encoder_ordinal)
Get the location of an encoder.
Definition: util.cc:1575
int32_t get_pdo_id(uint16_t index, uint8_t subindex, std::map< int32_t, int32_t > &pdo_position_map)
Uses a special map and its keys to get the PDO array positions.
Definition: util.cc:144
const char *const STACK_IMAGE_FILENAME
Definition: util.h:26
std::string string_bytes_to_hex_array_string(const std::string &bytes)
Convert bytes (as string) to a string of hex values.
Definition: util.cc:881
bool is_fw_based_on_v5(Cia402Drive &cia402_drive)
Check if the device requires the newer encoder configuration (FW >= v5 or FW >= v0....
Definition: util.cc:1417
EcatSlaveFoeError
Definition: util.h:386
bool is_future_done(std::future< R > const &f)
Check if the future has finished executing.
Definition: util.h:965
bool is_fw_at_least(Cia402Drive &cia402_drive, const std::string &version)
Check if the drive uses at least a certain FW version.
Definition: util.cc:1434
struct TuningParametersClass TuningParameters
struct SystemParametersClass SystemParameters
const char *const PLANT_MODEL_FILENAME
Definition: util.h:29
std::string get_firmware_version_string(Cia402Drive &cia402_drive)
Get the (string) version of the used firmware.
Definition: util.cc:893
std::string string_format(const std::string &format, Args... args)
Format a string like printf()
Definition: util.h:1009
auto to_integral(T e)
Return an integral type value of an enum class.
Definition: util.h:981
AutoTuningDriveConfiguration get_auto_tuning_drive_configuration(Cia402Drive &cia402_drive)
Get the configuration required for full auto-tuning.
Definition: util.cc:991
const std::string current_date_time()
Get the current time and date as a custom string.
Definition: util.cc:157
CirculoType get_circulo_type(int32_t hardware_id)
Get the Circulo type based on the hardware ID.
void set_csv_configuration(VirtualDevice *virtual_device, const std::vector< uint8_t > &csv_data)
Set the configuration parameter values from CSV data.
Definition: util.cc:492
Definition: cia402_drive.h:48
Holds position and velocity PID gains for a controller.
Definition: standalone_autotuning.h:58
This is a fourth order filter with binomial coefficients.
Definition: util.h:1051
double filter(double value)
Definition: util.cc:1683
This filter is second order with binomial coefficients, damping ratio xi = 1.
Definition: util.h:1031
double filter(double value)
Definition: util.cc:1649
Definition: virtual_device.h:20
uint8_t * value
Definition: co_dictionary.h:9
uint16_t index
Definition: co_dictionary.h:0
uint16_t notch_fw
Definition: util.h:74
int32_t R
Definition: util.h:79
int32_t L
Definition: util.h:78
nlohmann::json to_json()
Definition: util.h:90
double tc_kp
Definition: util.h:82
uint16_t notch_fc
Definition: util.h:75
int16_t vel_ff_gain
Definition: util.h:76
uint16_t tc_st
Definition: util.h:85
uint16_t tc_damping
Definition: util.h:86
double max_vel_noise
Definition: util.h:89
uint32_t vdc
Definition: util.h:80
uint8_t vel_lp_type
Definition: util.h:69
uint8_t switch_F
Definition: util.h:84
uint32_t vel_lp_fc
Definition: util.h:70
bool notch_en
Definition: util.h:73
double tc_ki
Definition: util.h:83
uint8_t pos_lp_type
Definition: util.h:71
uint32_t pos_lp_fc
Definition: util.h:72
std::string software_version
Definition: util.h:87
unsigned int rated_torque
Definition: util.h:88
uint16_t vel_ff_fc
Definition: util.h:77
double current_ratio
Definition: util.h:81
Definition: util.h:32
std::vector< double > denominator
Definition: util.h:34
nlohmann::json to_json()
Definition: util.h:35
std::vector< double > numerator
Definition: util.h:33
Definition: util.h:118
uint32_t nominal_torque
Definition: util.h:120
double time_step
Definition: util.h:119
uint32_t max_torque_mnm_
Definition: util.h:121
uint32_t singleturn_resolution
Definition: util.h:122
Definition: util.h:125
int16_t alpha_mult
Definition: util.h:137
double end_frequency
Definition: util.h:130
double warn_torque_const
Definition: util.h:145
double cutoff_frequency
Definition: util.h:131
double lb
Definition: util.h:148
uint16_t torque_amplitude
Definition: util.h:128
float velocity_loop_bandwidth
Definition: util.h:141
float velocity_damping
Definition: util.h:142
double start_frequency
Definition: util.h:129
ControllerType controller_type
Definition: util.h:134
double duration_seconds
Definition: util.h:127
double position_damping
Definition: util.h:136
double ub
Definition: util.h:149
double settling_time
Definition: util.h:135
uint8_t order
Definition: util.h:138