EduArt Sensor Ring Library 4.0.0
Loading...
Searching...
No Matches
SensorBoardType.hpp File Reference

Board type enum for sensor board hardware variants (matches firmware). More...

#include <ostream>
#include <string>
#include "sensorring/platform/SensorringExport.hpp"
Include dependency graph for SensorBoardType.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::board::SensorBoardType {
  Sidepanel = 0x00 , Headlight = 0x01 , Taillight = 0x02 , Minipanel = 0x03 ,
  Undefined = 0xff
}
 Hardware variant of a sensor board. More...

Functions

SENSORRING_EXPORT std::string eduart::sensorring::board::toString (SensorBoardType type) noexcept
 Format sensor board type as string.
SENSORRING_EXPORT std::ostream & eduart::sensorring::board::operator<< (std::ostream &os, const SensorBoardType type) noexcept
 Stream sensor board type as string.

Detailed Description

Board type enum for sensor board hardware variants (matches firmware).

Author
EduArt Robotik GmbH
Date
2026-02-17

Enumeration Type Documentation

◆ SensorBoardType

Hardware variant of a sensor board.

The numeric values match the board-type field reported by the sensor board firmware during enumeration.

Enumerator
Sidepanel 

Sidepanel board.

Headlight 

Headlight board.

Taillight 

Taillight board.

Minipanel 

Minipanel board.

Undefined 

Board type could not be determined.

Function Documentation

◆ operator<<()

SENSORRING_EXPORT std::ostream & eduart::sensorring::board::operator<< ( std::ostream & os,
const SensorBoardType type )
noexcept

Stream sensor board type as string.

Parameters
[in]osOutput stream.
[in]typeSensor board type to print.
Returns
Reference to os.

◆ toString()

SENSORRING_EXPORT std::string eduart::sensorring::board::toString ( SensorBoardType type)
noexcept

Format sensor board type as string.

Returns
Sensor board type string.