EduArt Sensor Ring Library 3.0.1
Loading...
Searching...
No Matches
Parameter.hpp
Go to the documentation of this file.
1// Copyright (c) 2025 EduArt Robotik GmbH
2
9
10#pragma once
11
12#include <chrono>
13#include <string>
14#include <vector>
15
19
20namespace eduart {
21
22namespace sensor {
23
28enum class SENSORRING_API Orientation {
29 left,
30 right,
31 none
32};
33
38struct SENSORRING_API LightParams {
40 bool enable = false;
41
43 Orientation orientation = Orientation::none;
44};
45
50struct SENSORRING_API ThermalSensorParams {
52 int user_idx = 0;
53
55 bool enable = false;
56
58 double t_min_deg_c = 0;
59
61 double t_max_deg_c = 0;
62
64 bool auto_min_max = false;
65
67 bool use_eeprom_file = false;
68
71
73 std::string eeprom_dir = "";
74
76 std::string calibration_dir = "";
77
79 Orientation orientation = Orientation::none;
80};
81
86struct SENSORRING_API TofSensorParams {
88 int user_idx = 0;
89
91 bool enable = false;
92};
93
114
115} // namespace sensor
116
117namespace bus {
118
124struct SENSORRING_API BusParams {
126 std::string interface_name;
127
129 com::InterfaceType type = com::InterfaceType::UNDEFINED;
130
132 std::vector<sensor::SensorBoardParams> board_param_vec;
133};
134
135} // namespace bus
136
137namespace ring {
138
145struct SENSORRING_API RingParams {
147 std::chrono::milliseconds timeout = std::chrono::milliseconds(1000);
148
150 std::vector<bus::BusParams> bus_param_vec;
151};
152
153} // namespace ring
154
155namespace manager {
156
163struct SENSORRING_API ManagerParams {
165 bool enable_brs = false;
166
168 bool print_topology = true;
169
171 bool repair_errors = true;
172
174 bool enforce_topology = false;
175
177 double frequency_tof_hz = 0.0;
178
181
184};
185
186} // namespace manager
187
188} // namespace eduart
Interface type definition.
Collection of math functions.
Control the import and export of Windows DLL symbols.
Parameter structure of a communication bus. A bus is one communication interface e....
Definition Parameter.hpp:124
com::InterfaceType type
Type of the communication interface. Only interface types that are defined in com::InterfaceType are ...
Definition Parameter.hpp:129
std::string interface_name
Name of the communication interface. E.g. "can0" for a CAN bus.
Definition Parameter.hpp:126
std::vector< sensor::SensorBoardParams > board_param_vec
Parameters of the sensor boards that are connected through this communication interface....
Definition Parameter.hpp:132
Parameter structure of the MeasurementManager. The MeasurementManager handles the timing and communic...
Definition Parameter.hpp:163
double frequency_tof_hz
Target frequency for the time of flight measurement. If set to 0.0 the measurements are executed as f...
Definition Parameter.hpp:177
bool print_topology
If set to true a formatted string describing the sensor topology is printed via the Logger when the M...
Definition Parameter.hpp:168
double frequency_thermal_hz
Target frequency for the thermal measurement. If set to 0.0 the measurements are executed as fast as ...
Definition Parameter.hpp:180
bool enforce_topology
If set to true the MeasurementManager will only start when the configured topology matches the actual...
Definition Parameter.hpp:174
ring::RingParams ring_params
Parameters of the sensor ring that will be managed by the MeasurementManager.
Definition Parameter.hpp:183
bool enable_brs
Enable bit rate switching on the can bus interface.
Definition Parameter.hpp:165
bool repair_errors
If set to true error handling is enabled to try to repair communication and timing errors....
Definition Parameter.hpp:171
Vector of length 3.
Definition Vector3.hpp:25
Parameter structure of a sensor ring. The sensor ring is the abstraction of the whole sensor system a...
Definition Parameter.hpp:145
std::chrono::milliseconds timeout
Timeout for the measurements before the error handler is called.
Definition Parameter.hpp:147
std::vector< bus::BusParams > bus_param_vec
Parameters of the communication interfaces that will be included in the sensor ring....
Definition Parameter.hpp:150
Parameter structure of the sensor lights of a sensor board. Not all sensor boards have lights.
Definition Parameter.hpp:38
Orientation orientation
Orientation of the sensor board. Used to to mirror the light animations.
Definition Parameter.hpp:43
bool enable
Enable the lights.
Definition Parameter.hpp:40
Parameter structure of a sensor board. A sensor board is one circuit board.
Definition Parameter.hpp:98
LightParams light_params
Parameters of the lights on the sensor board. Only applicable if the corresponding hardware actually ...
Definition Parameter.hpp:106
TofSensorParams tof_params
Parameters of the time of flight sensor on the sensor board. Only applicable if the corresponding har...
Definition Parameter.hpp:109
math::Vector3 rotation
Rotation part of the sensors pose. The rotation is applied in the order Roll(x) - Pitch(y) - Yaw(z)....
Definition Parameter.hpp:100
ThermalSensorParams thermal_params
Parameters of the thermal sensor on the sensor board. Only applicable if the corresponding hardware a...
Definition Parameter.hpp:112
math::Vector3 translation
Translation part of the sensor pose. Values: XYZ coordinates in meters.
Definition Parameter.hpp:103
Parameter structure of the thermal sensor of a sensor board. Not all sensor boards have thermal senso...
Definition Parameter.hpp:50
bool use_calibration_file
Save the calibration data for the thermal sensor to a local file to only require the calibration proc...
Definition Parameter.hpp:70
double t_max_deg_c
Maximal temperature in degree celsius used for color mapping of the thermal images....
Definition Parameter.hpp:61
int user_idx
Customizable index that is returned with every measurement from this sensor.
Definition Parameter.hpp:52
bool auto_min_max
Enable automatic color scaling of the thermal images using the coldest and the hottest temperature in...
Definition Parameter.hpp:64
std::string eeprom_dir
Directory of the eeprom file. The user requires read and write access to this directory.
Definition Parameter.hpp:73
Orientation orientation
Orientation of the sensor board. Used to flip the image upside down.
Definition Parameter.hpp:79
std::string calibration_dir
Directory of the calibration data file. The user requires read and write access to this directory.
Definition Parameter.hpp:76
bool use_eeprom_file
Save the thermal sensors eeprom content to a local file to only require a transfer once.
Definition Parameter.hpp:67
double t_min_deg_c
Minimal temperature in degree celsius used for color mapping of the thermal images....
Definition Parameter.hpp:58
bool enable
Enable thermal measurements from this sensor.
Definition Parameter.hpp:55
Parameter structure of the Time-of-Flight sensor of a sensor board.
Definition Parameter.hpp:86
bool enable
Enable time of flight measurements from this sensor.
Definition Parameter.hpp:91
int user_idx
Customizable index that is returned with every measurement from this sensor.
Definition Parameter.hpp:88