EduArt Sensor Ring Library 4.0.0
Loading...
Searching...
No Matches
TMF8829_Device.hpp
Go to the documentation of this file.
1// Copyright (c) 2026 EduArt Robotik GmbH
2
9
10#pragma once
11
12#include <memory>
13#include <vector>
14
20#include "sensorring/platform/SensorringExport.hpp"
21
22namespace eduart {
23
24namespace sensorring {
25
26namespace device {
27
28class TMF8829_DeviceImpl;
29
34class SENSORRING_EXPORT TMF8829_Device : public DepthSensor {
35public:
42 TMF8829_Device(TMF8829_Params params, com::ComInterfaceID interface, unsigned int idx);
43
46
51 const TMF8829_Params& getParams() const override;
52
59
66
72 bool setIterationsSetting(std::uint16_t k_iterations);
73
79 bool getIterationsSetting(std::uint16_t& k_iterations);
80
87
94
100 bool setResultFullNoise(bool full_noise);
101
107 bool getResultFullNoise(bool& full_noise);
108
114 bool setResultXtalk(bool xtalk);
115
121 bool getResultXtalk(bool& xtalk);
122
128 bool setResultNoiseStrength(bool noise_strength);
129
135 bool getResultNoiseStrength(bool& noise_strength);
136
142 bool setResultSignalStrength(bool signal_strength);
143
149 bool getResultSignalStrength(bool& signal_strength);
150
156 bool setResultNrOfPeaks(std::uint8_t nr_of_peaks);
157
163 bool getResultNrOfPeaks(std::uint8_t& nr_of_peaks);
164
169 bool configure() override;
170
171protected:
172 bool sendMeasurementRequest(std::uint8_t sequence_number) override;
173 bool sendMeasurementTransmissionRequest() override;
174
175private:
181 void comCallback(const com::ComEndpoint source, std::uint8_t command, const std::vector<uint8_t>& data) override;
182
183 friend class TMF8829_DeviceImpl;
184 std::unique_ptr<TMF8829_DeviceImpl> _impl;
185};
186
187} // namespace device
188
189} // namespace sensorring
190
191} // namespace eduart
Interface type definition.
Pure data structure for depth sensor measurements.
Abstract interface for depth-sensing devices (ToF, structured light, etc.).
Collection of math functions.
Parameter structure for the TMF8829 Time-of-Flight sensor.
ResolutionMode
Supported resolution modes of the TMF8829 sensor.
Definition TMF8829_Params.hpp:27
DepthSensor(DeviceID id, com::ComInterface *interface, com::ComEndpoint target, DepthSensorConfig config)
Construct a DepthSensor with Device params, field-of-view and pixel resolution.
bool setResolutionMode(ResolutionMode mode)
Set the resolution mode of the sensor.
bool getResultXtalk(bool &xtalk)
Get whether crosstalk data is included in measurement results.
bool getIterationsSetting(std::uint16_t &k_iterations)
Get the iterations setting of the sensor in kilo iteration per measurement.
bool setResultFullNoise(bool full_noise)
Enable or disable full noise data in measurement results.
bool getResultSignalStrength(bool &signal_strength)
Get whether signal strength data is included in measurement results.
bool setResultFormat(TMF8829_ResultFormat format)
Set the result format of the sensor.
bool configure() override
Re-apply runtime configuration after a board reset.
bool getResultFullNoise(bool &full_noise)
Get whether full noise data is included in measurement results.
const TMF8829_Params & getParams() const override
Get the sensor parameters used to configure this device.
bool getResolutionMode(ResolutionMode &mode)
Get the resolution mode of the sensor.
TMF8829_Device(TMF8829_Params params, com::ComInterfaceID interface, unsigned int idx)
Construct a new TMF8829 device instance.
bool setResultNoiseStrength(bool noise_strength)
Enable or disable noise strength data in measurement results.
bool getResultNrOfPeaks(std::uint8_t &nr_of_peaks)
Get the maximum number of peaks reported per pixel in measurement results.
bool setResultNrOfPeaks(std::uint8_t nr_of_peaks)
Set the maximum number of peaks reported per pixel in measurement results.
bool setIterationsSetting(std::uint16_t k_iterations)
Set the iterations setting of the sensor in kilo iteration per measurement.
bool getResultNoiseStrength(bool &noise_strength)
Get whether noise strength data is included in measurement results.
bool setResultSignalStrength(bool signal_strength)
Enable or disable signal strength data in measurement results.
bool setResultXtalk(bool xtalk)
Enable or disable crosstalk data in measurement results.
bool getResultFormat(TMF8829_ResultFormat &format)
Get the result format of the sensor.
Uniquely identifies a communication endpoint as a (Direction, BoardAddress, DeviceId) tuple.
Definition ComEndpoint.hpp:37
Uniquely identifies a communication interface by type and name.
Definition ComInterfaceID.hpp:51
Parameter structure of the TMF8829 sensor of a sensor board.
Definition TMF8829_Params.hpp:72
Specifies which values are included in the TMF8829 measurement.
Definition TMF8829_ResultFormat.hpp:27