Version, commit hash, and board enumeration info reported by hardware. More...

#include <cstdint>
#include <iostream>
#include <string>
#include <vector>
#include "sensorring/device/DeviceType.hpp"
#include "sensorring/device/hardware/SensorBoardType.hpp"
#include "sensorring/platform/SensorringExport.hpp"

Include dependency graph for EnumerationInformation.hpp:

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

Go to the source code of this file.

Classes
struct	eduart::Version
	Semantic version (major, minor, patch) for firmware or board. More...
struct	eduart::CommitHash
	32-bit commit hash (e.g. from firmware) with byte-wise construction and string output. More...
struct	eduart::device::EnumerationInformation
	Information reported by a board during enumeration: index, version, commit hash, board type, and state. More...

Enumerations
enum class	eduart::device::ConnectionState { Undefined , Connected , Unconnected }
	Physical connection state of a board after enumeration.
enum class	eduart::device::ConfigurationState { Undefined , Configured , Unconfigured }
	Whether a board or device was declared by the user via the factory. More...

Functions
SENSORRING_EXPORT std::string	eduart::device::toString (ConnectionState state)
	Convert connection state to a human-readable string.
SENSORRING_EXPORT std::string	eduart::device::toString (ConfigurationState state)
	Convert configuration state to a human-readable string.
SENSORRING_EXPORT std::ostream &	eduart::device::operator<< (std::ostream &os, const ConnectionState state) noexcept
	Stream connection state as string.
SENSORRING_EXPORT std::ostream &	eduart::device::operator<< (std::ostream &os, const ConfigurationState state) noexcept
	Stream configuration state as string.

Detailed Description

Version, commit hash, and board enumeration info reported by hardware.

Author: EduArt Robotik GmbH

Date: 2025-02-19

Enumeration Type Documentation

◆ ConfigurationState

enum class eduart::device::ConfigurationState

strong

Whether a board or device was declared by the user via the factory.

Enumerator
Undefined	State has not been determined yet.
Configured	The board/device was declared by the user (expectBoard) and matched by the factory.
Unconfigured	The board/device was discovered by hardware but not declared by the user.

Function Documentation

◆ toString() [1/2]

SENSORRING_EXPORT std::string eduart::device::toString ( ConfigurationState state )

Convert configuration state to a human-readable string.

Parameters

[in] state Configuration state.

Returns: String representation of state.

◆ toString() [2/2]

SENSORRING_EXPORT std::string eduart::device::toString ( ConnectionState state )

Convert connection state to a human-readable string.

Parameters

[in] state Connection state.

Returns: String representation of state.

Classes