TMF8829_Params.hpp File Reference

Parameter structure for the TMF8829 Time-of-Flight sensor. More...

#include <cstddef>
#include <cstdint>
#include "sensorring/device/depth/DepthSensorParams.hpp"
#include "sensorring/device/depth/tmf8829/TMF8829_ResultFormat.hpp"
#include "sensorring/platform/SensorringExport.hpp"

Include dependency graph for TMF8829_Params.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	eduart::sensorring::device::TMF8829_Params
	Parameter structure of the TMF8829 sensor of a sensor board. More...

Enumerations
enum class	eduart::sensorring::device::ResolutionMode : std::uint8_t {   Res8x8 = 0 , Res8x8LongRange = 1 , Res8x8HighAccuracy = 2 , Res16x16 = 3 ,   Res16x16HighAccuracy = 4 , Res32x32 = 5 , Res32x32HighAccuracy = 6 , Res48x32 = 7 ,   Res48x32HighAccuracy = 8 }
	Supported resolution modes of the TMF8829 sensor.

Functions
unsigned int	eduart::sensorring::device::getXResolution (ResolutionMode mode)
	Get the horizontal resolution (number of columns) for a given resolution mode.
unsigned int	eduart::sensorring::device::getYResolution (ResolutionMode mode)
	Get the vertical resolution (number of rows) for a given resolution mode.
SENSORRING_EXPORT std::string	eduart::sensorring::device::toString (ResolutionMode mode) noexcept
	Function to convert the ResolutionMode enum class members to string.
SENSORRING_EXPORT std::ostream &	eduart::sensorring::device::operator<< (std::ostream &os, ResolutionMode mode) noexcept
	Output stream operator for the ResolutionMode enum class members.

Detailed Description

Parameter structure for the TMF8829 Time-of-Flight sensor.

Author

EduArt Robotik GmbH

Date

2026-05-08

Function Documentation

getXResolution()

unsigned int eduart::sensorring::device::getXResolution

(

ResolutionMode

mode

)

Get the horizontal resolution (number of columns) for a given resolution mode.

Parameters

[in]

mode

Resolution mode for which to get the horizontal resolution.

Returns

Number of columns in the TMF8829 frame for the specified resolution mode.

getYResolution()

unsigned int eduart::sensorring::device::getYResolution

(

ResolutionMode

mode

)

Get the vertical resolution (number of rows) for a given resolution mode.

Parameters

[in]

mode

Resolution mode for which to get the vertical resolution.

Returns

Number of rows in the TMF8829 frame for the specified resolution mode.

operator<<()

SENSORRING_EXPORT std::ostream & eduart::sensorring::device::operator<< ( std::ostream & os, ResolutionMode mode )

noexcept

Output stream operator for the ResolutionMode enum class members.

Parameters

[in]	os	output stream to write to
[in]	mode	to be printed as stream

Returns

Stream with the resolution mode name written out

toString()

SENSORRING_EXPORT std::string eduart::sensorring::device::toString ( ResolutionMode mode )

noexcept

Function to convert the ResolutionMode enum class members to string.

Parameters

[in]

mode

to be converted to a string

Returns

Name of the resolution mode written out as string