Classes link

• namespace peary
  • namespace board
    • namespace carboard
      • class ADCInput ADC input resource for CaR board.
      • class BiasRegulator Bias voltage regulator resource for CaR board.
      • class CMOSLevels CMOS level shifter resource for CaR board.
      • class Carboard Carboard class representing the CaR board.
      • class ClockGenerator Clock generator resource for CaR board.
      • class CurrentSource Current source resource for CaR board.
      • class EEPROM EEPROM resource for CaR board.
      • class TemperatureSensor Temperature sensor resource for CaR board.
      • class VoltageRegulator Voltage regulator resource for CaR board.
      • class ZynqClockGenerator Clock generator resource on Zynq board.
  • namespace component
    • class ADS7828 ADS7828 8-Channel 12-Bit A/D Converter Component.
    • class ComponentError Base class for component-related errors This class is used as a base for all component-related exceptions in the Peary library.
    • class ComponentStateError Exception class for component state errors This class is used to represent errors that occur due to invalid component states.
    • class DAC7678 DAC7678 Digital-to-Analog Converter Component.
    • class EEPROM24LC32A EEPROM24LC32A I2C EEPROM Component.
    • class INA226 INA226 Power Monitor Component.
    • class PCA9539 PCA9539 I/O Expander Component.
    • class Si5345 Si5345 Frequency Synthesizer Component.
    • class Si570 Si570 Clock Generator.
    • class TMP101 TMP101 Temperature Sensor Component.
  • namespace config
    • class ConfigParser Simple parser class for TOML-like configurations consisting of sections indicated by […] and key-value pairs.
    • class Configuration Configuration class holding key-value pairs of configuration parameters.
    • class ConfigurationError Base class for configuration-related errors.
    • class InvalidKeyError Exception class for invalid configuration keys.
    • class InvalidSectionError Exception class for invalid configuration sections.
    • class InvalidTypeError Exception class for invalid configuration types.
    • class InvalidValueError Exception class for invalid configuration values.
    • class MissingKeyError Exception class for missing configuration keys.
  • namespace device Forward declaration of CaribouDevice, Board, and Carboard classes.
    • class AuxiliaryDevice Caribou Auxiliary Device class definition.
    • class CaribouDevice Caribou Device class definition.
    • class DataTakingError Exception class for data taking errors.
    • class Device Abstract Caribou Device class definition.
    • class DeviceError Base class for device-related errors.
    • class DeviceManager Caribou Device Manager.
    • class InvalidDeviceError Exception class for invalid device errors.
    • class InvalidInstanceError Exception class for running instance errors.
    • class LibraryError Exception class for library errors.
  • namespace hal
    • class AlertMonitor A resource which can monitor alerts.
    • class Board Base class for a hardware board.
    • class ClockSynthesizer A resource which can control a clock multiplier and jitter attenuator.
    • class Component This class serves as base class for a unified interface to hardware components.
    • class CurrentControl A resource which can control a current source.
    • class CurrentLimiter A resource which can control a voltage level.
    • class CurrentProvider A resource which can read a current value.
    • class E2Reader A resource that can read from memory.
    • class E2Writer A resource that can write to memory.
    • class HalError Base class for HAL-related errors.
    • class InvalidResourceError Exception class for invalid resources.
    • class Oscillator A resource which can control an oscillator.
    • class PowerProvider A resource which can read a wattage.
    • class Resource Base class for resources.
    • class SwitchControl A resource which can control a switch.
    • class SwitchStatus A resource which can read the status of a switch.
    • class TemperatureProvider A resource which can read a temperature value.
    • class VoltageControl A resource which can control a voltage level.
    • class VoltageProvider A resource which can read a voltage level.
  • namespace interface
    • class CommunicationError Exception class for communication errors.
    • class Interface Abstract base class for communication interfaces.
    • class InterfaceConfiguration Class representing the configuration of an interface.
    • class InterfaceDeviceError Exception class for interface-related errors.
    • class InterfaceError Base class for interface-related errors.
    • class InterfaceManager Singleton class to manage interface instances.
    • class iface_i2c I2C interface via Kernel I2C module.
    • class iface_i2c_config Configuration class for I2C interface.
    • class iface_ipsocket Configuration class for IPSocket interface.
    • class iface_loopback Peary Loopback Interface.
    • class iface_loopback_config Configuration class for Loopback interface.
    • class iface_mem Peary Memory Interface.
    • class iface_mem_config Configuration class for Memory interface.
    • class iface_sermem Peary Serial Memory Interface.
    • class iface_sermem_config Configuration class for Serial Memory interface.
    • class iface_spi SPI interface class.
    • class iface_spi_CLICpix2 Class representing the SPI interface for CLICpix2 devices.
    • class iface_spi_bus
    • class iface_spi_bus_config Configuration class for SPI bus interface.
  • namespace log
    • class Log Log of the framework to inform the user of process.
  • namespace utils
    • class DictionnaryError Exception class for dictionary errors.
    • class Dispatcher Command dispatcher class.
      • struct Command Structure to hold command information.
    • class Exception Base exception class for Peary.
    • class InvalidArgumentError Exception class for invalid arguments.
    • class InvalidCommandError Exception class for invalid commands.
    • class LFSR Linear Feedback Shift Register (LFSR) class.
    • class LogicError Exception class for logic errors.
    • class MissingImplementationError
    • class RuntimeError Exception class for runtime errors.
    • struct SI5345_REG_T Struct to represent a register in the SI5345.
    • class dictionary Dictionary class for storing elements for lookup.
    • namespace dispatcher_impl
      • struct NativeInterfaceWrappper Wrapper for native interface functions that return a value.
      • struct NativeInterfaceWrappper< void, Args… > Wrapper for native interface functions that do not return a value.
    • class memory_map Class to represent a memory map.
    • struct pearyRawDataWord Represents a raw data word.
    • class pixel Basic pixel class.
    • class register_t Class to represent a register configuration.
    • struct string_hash Hash for std::unordered_map.
• namespace std

Updated on 2025-11-28 at 17:53:40 +0100