EduArt Sensor Ring Library 4.0.0
Loading...
Searching...
No Matches
eduart::sensorring::com::ComEndpoint Struct Reference

Uniquely identifies a communication endpoint as a (Direction, BoardAddress, DeviceId) tuple. More...

#include <ComEndpoint.hpp>

Public Member Functions

bool operator== (const ComEndpoint &other) const
 Equality comparison for ComEndpoint (compares direction, board address, and device ID).
bool operator!= (const ComEndpoint &other) const
 Inequality comparison for ComEndpoint.
std::string toString () const
 Human-readable representation for logging.

Public Attributes

Direction direction
 Host->Board (Input) or Board->Host (Output).
std::uint8_t boardAddress
 0 = broadcast, 1-126 = individual board (board_index + 1)
std::uint8_t deviceId
 0x00 = board, 0x01 = ToF, 0x02 = Thermal, 0x03 = WS2812b

Static Public Attributes

static constexpr std::uint8_t BROADCAST = 0x00
 Broadcast board address (node ID 0x00 per existing CAN convention).
static constexpr std::uint8_t ANY_BOARD = 0xFF
 Subscription wildcard: matches any board address during dispatch.

Detailed Description

Uniquely identifies a communication endpoint as a (Direction, BoardAddress, DeviceId) tuple.

Member Function Documentation

◆ toString()

std::string eduart::sensorring::com::ComEndpoint::toString ( ) const

Human-readable representation for logging.

Returns
e.g. "Input/Board5/VL53L8CX", "Output/Broadcast/Board", "Input/ANY/Board"

The documentation for this struct was generated from the following file: