SensorRingFactory.hpp

Go to the documentation of this file.

// Copyright (c) 2026 EduArt Robotik GmbH

 
#pragma once
 
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "sensorring/SensorRing.hpp"
#include "sensorring/board/EnumerationInformation.hpp"
#include "sensorring/board/SensorBoardParams.hpp"
#include "sensorring/device/DeviceParams.hpp"
#include "sensorring/device/DeviceType.hpp"
#include "sensorring/device/depth/DepthSensorParams.hpp"
#include "sensorring/device/depth/tmf8829/TMF8829_Params.hpp"
#include "sensorring/device/depth/vl53l8cx/VL53L8CX_Params.hpp"
#include "sensorring/device/light/LightParams.hpp"
#include "sensorring/device/light/ws2812b/WS2812b_Params.hpp"
#include "sensorring/device/thermal/ThermalSensorParams.hpp"
#include "sensorring/device/thermal/htpa32/HTPA32_Params.hpp"
#include "sensorring/interface/ComInterfaceID.hpp"
#include "sensorring/interface/InterfaceParams.hpp"
#include "sensorring/platform/SensorringExport.hpp"
 
namespace eduart {
 
namespace sensorring {
 
class SensorRingFactoryImpl;

enum class ValidationMode {
  Strict,
  Relaxed
};

class SENSORRING_EXPORT SensorRingFactory {
public:
  using EnumerationMap = std::unordered_map<com::ComInterfaceID, std::vector<board::EnumerationInformation> >;

  static constexpr Version MIN_FIRMWARE_VERSION = { 0, 9, 0 };

  explicit SensorRingFactory(ValidationMode mode = ValidationMode::Relaxed);
  ~SensorRingFactory();
 
  // ── Interface configuration ──

  void addInterface(com::SocketCanParams params);

  void addInterface(com::UsbTingoParams params);
 
  // ── Board expectations ──

  void expectBoard(board::SensorBoardParams params = {});
 
  // ── Device expectations (applied to the last expectBoard) ──

  void expectDevice(device::DeviceType type);

  void expectDevice(device::VL53L8CX_Params params);

  void expectDevice(device::TMF8829_Params params);

  void expectDevice(device::HTPA32_Params params);

  void expectDevice(device::WS2812b_Params params);

  void expectDevice(device::DepthSensorParams params);

  void expectDevice(device::ThermalSensorParams params);

  void expectDevice(device::LightParams params);
 
  // ── Default device parameters ──

  void setDefaultDeviceParams(device::VL53L8CX_Params params);

  void setDefaultDeviceParams(device::TMF8829_Params params);

  void setDefaultDeviceParams(device::HTPA32_Params params);

  void setDefaultDeviceParams(device::WS2812b_Params params);

  void setDefaultDeviceParams(device::DepthSensorParams params);

  void setDefaultDeviceParams(device::ThermalSensorParams params);

  void setDefaultDeviceParams(device::LightParams params);
 
  // ── Build ──

  std::unique_ptr<SensorRing> build();

  EnumerationMap enumerate();

  const EnumerationMap& getLatestEnumerationResult() const;

  std::string printTopology() const;

  void reset();
 
private:
  std::unique_ptr<SensorRingFactoryImpl> _impl;
};
 
} // namespace sensorring
 
} // namespace eduart