DeviceType.hpp File Reference

Enumeration of supported device hardware types. More...

#include <ostream>
#include <string>
#include "sensorring/platform/SensorringExport.hpp"

Include dependency graph for DeviceType.hpp:

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

Go to the source code of this file.

Enumerations
enum class	eduart::sensorring::device::DeviceType {   SensorBoard , VL53L8CX , HTPA32 , WS2812b ,   TMF8829 , Undefined , AnyDepth , AnyThermal ,   AnyLight }
	Supported device hardware types used for device registration and grouping. More...

Functions
SENSORRING_EXPORT std::string	eduart::sensorring::device::toString (DeviceType type) noexcept
	Format device type as string.
SENSORRING_EXPORT bool	eduart::sensorring::device::isCategory (DeviceType type) noexcept
	Returns true if type is a category wildcard (AnyDepth, AnyThermal, AnyLight).
SENSORRING_EXPORT bool	eduart::sensorring::device::deviceMatchesExpected (DeviceType actual, DeviceType expected) noexcept
	Returns true if actual matches expected exactly, or if expected is a category wildcard and actual belongs to that category.
SENSORRING_EXPORT std::ostream &	eduart::sensorring::device::operator<< (std::ostream &os, const DeviceType type) noexcept
	Stream device type as string.

Detailed Description

Enumeration of supported device hardware types.

Author

EduArt Robotik GmbH

Date

2025-02-16

Enumeration Type Documentation

DeviceType

enum class eduart::sensorring::device::DeviceType

strong

Supported device hardware types used for device registration and grouping.

Enumerator
SensorBoard	Base board (for reset, firmware revision, etc.).
VL53L8CX	Time-of-flight sensor (VL53L8CX).
HTPA32	Thermal sensor (HTPA32).
WS2812b	LED strip (WS2812b).
TMF8829	Time-of-flight sensor (TMF8829).
Undefined	Undefined device type.
AnyDepth	Category wildcard: matches any depth sensor (VL53L8CX, TMF8829, ...).
AnyThermal	Category wildcard: matches any thermal sensor (HTPA32, ...).
AnyLight	Category wildcard: matches any light device (WS2812b, ...).

Function Documentation

operator<<()

SENSORRING_EXPORT std::ostream & eduart::sensorring::device::operator<< ( std::ostream & os, const DeviceType type )

noexcept

Stream device type as string.

Parameters

[in]	os	Output stream.
[in]	type	Device type to print.

Returns

Reference to os.

toString()

SENSORRING_EXPORT std::string eduart::sensorring::device::toString ( DeviceType type )

noexcept

Format device type as string.

Returns

Device type string.