• About the Project
    • Getting Support
    • Contributing
    • Overview
    • Setup Environment
    • Peta-Manager
    • Build Workflow
    • Overview
    • Setup Environment
    • Boreal Manager
    • Build Workflow
    • Integration Workflow
    • Overview
    • Installation
    • Executables
    • Framework
    • Utilities
    • Devices
        • peary::board::carboard::ADCInput
        • peary::board::carboard::BiasRegulator
        • peary::board::carboard::Carboard
        • peary::board::carboard::ClockGenerator
        • peary::board::carboard::CMOSLevels
        • peary::board::carboard::CurrentSource
        • peary::board::carboard::EEPROM
        • peary::board::carboard::TemperatureSensor
        • peary::board::carboard::VoltageRegulator
        • peary::board::carboard::ZynqClockGenerator
        • peary::component::ADS7828
        • peary::component::ComponentError
        • peary::component::ComponentStateError
        • peary::component::DAC7678
        • peary::component::EEPROM24LC32A
        • peary::component::INA226
        • peary::component::PCA9539
        • peary::component::Si5345
        • peary::component::Si570
        • peary::component::TMP101
        • peary::config::ConfigParser
        • peary::config::Configuration
        • peary::config::ConfigurationError
        • peary::config::InvalidKeyError
        • peary::config::InvalidSectionError
        • peary::config::InvalidTypeError
        • peary::config::InvalidValueError
        • peary::config::MissingKeyError
        • peary::device::AuxiliaryDevice
        • peary::device::CaribouDevice
        • peary::device::DataTakingError
        • peary::device::Device
        • peary::device::DeviceError
        • peary::device::DeviceManager
        • peary::device::InvalidDeviceError
        • peary::device::InvalidInstanceError
        • peary::device::LibraryError
        • peary::hal::AlertMonitor
        • peary::hal::Board
        • peary::hal::ClockSynthesizer
        • peary::hal::Component
        • peary::hal::CurrentControl
        • peary::hal::CurrentLimiter
        • peary::hal::CurrentProvider
        • peary::hal::E2Reader
        • peary::hal::E2Writer
        • peary::hal::HalError
        • peary::hal::InvalidResourceError
        • peary::hal::Oscillator
        • peary::hal::PowerProvider
        • peary::hal::Resource
        • peary::hal::SwitchControl
        • peary::hal::SwitchStatus
        • peary::hal::TemperatureProvider
        • peary::hal::VoltageControl
        • peary::hal::VoltageProvider
        • peary::interface::CommunicationError
        • peary::interface::iface_i2c
        • peary::interface::iface_i2c_config
        • peary::interface::iface_ipsocket
        • peary::interface::iface_loopback
        • peary::interface::iface_loopback_config
        • peary::interface::iface_mem
        • peary::interface::iface_mem_config
        • peary::interface::iface_sermem
        • peary::interface::iface_sermem_config
        • peary::interface::iface_spi
        • peary::interface::iface_spi_bus
        • peary::interface::iface_spi_bus_config
        • peary::interface::iface_spi_CLICpix2
        • peary::interface::Interface
        • peary::interface::InterfaceConfiguration
        • peary::interface::InterfaceDeviceError
        • peary::interface::InterfaceError
        • peary::interface::InterfaceManager
        • peary::log::Log
        • peary::utils::dictionary
        • peary::utils::DictionnaryError
        • peary::utils::Dispatcher
        • peary::utils::dispatcher_impl::NativeInterfaceWrappper
        • peary::utils::dispatcher_impl::NativeInterfaceWrappper< void, Args... >
        • peary::utils::Dispatcher::Command
        • peary::utils::Exception
        • peary::utils::InvalidArgumentError
        • peary::utils::InvalidCommandError
        • peary::utils::LFSR
        • peary::utils::LogicError
        • peary::utils::memory_map
        • peary::utils::MissingImplementationError
        • peary::utils::pearyRawDataWord
        • peary::utils::pixel
        • peary::utils::register_t
        • peary::utils::RuntimeError
        • peary::utils::SI5345_REG_T
        • peary::utils::string_hash
        • peary
        • peary/config
        • peary/config/configuration.hpp
        • peary/config/exceptions.hpp
        • peary/device
        • peary/device/AuxiliaryDevice.hpp
        • peary/device/CaribouDevice.hpp
        • peary/device/Device.hpp
        • peary/device/DeviceManager.hpp
        • peary/device/exceptions.hpp
        • peary/hal
        • peary/hal/Board.hpp
        • peary/hal/Components.hpp
        • peary/hal/exceptions.hpp
        • peary/hal/Resources.hpp
        • peary/hardware
        • peary/hardware/boards
        • peary/hardware/boards/Carboard.hpp
        • peary/hardware/boards/CarboardConstants.hpp
        • peary/hardware/components
        • peary/hardware/components/ADS7828.hpp
        • peary/hardware/components/DAC7678.hpp
        • peary/hardware/components/EEPROM24LC32A.hpp
        • peary/hardware/components/exceptions.hpp
        • peary/hardware/components/INA226.hpp
        • peary/hardware/components/PCA9539.hpp
        • peary/hardware/components/Si5345.hpp
        • peary/hardware/components/Si570.hpp
        • peary/hardware/components/TMP101.hpp
        • peary/interfaces
        • peary/interfaces/exceptions.hpp
        • peary/interfaces/I2C
        • peary/interfaces/I2C/i2c.hpp
        • peary/interfaces/Interface.hpp
        • peary/interfaces/interfaceConfiguration.hpp
        • peary/interfaces/InterfaceManager.hpp
        • peary/interfaces/IPSocket
        • peary/interfaces/IPSocket/ipsocket.hpp
        • peary/interfaces/Loopback
        • peary/interfaces/Loopback/loopback.hpp
        • peary/interfaces/Memory
        • peary/interfaces/Memory/memory.hpp
        • peary/interfaces/SerialMemory
        • peary/interfaces/SerialMemory/serialmemory.hpp
        • peary/interfaces/SPI
        • peary/interfaces/SPI_BUS
        • peary/interfaces/SPI_BUS/spi_bus.hpp
        • peary/interfaces/SPI_CLICpix2
        • peary/interfaces/SPI_CLICpix2/spi_CLICpix2.hpp
        • peary/interfaces/SPI/spi.hpp
        • peary/log
        • peary/log/log.hpp
        • peary/log/logging.hpp
        • peary/utils
        • peary/utils/constants.hpp
        • peary/utils/datatypes.hpp
        • peary/utils/dictionary.hpp
        • peary/utils/dispatcher.hpp
        • peary/utils/exceptions.hpp
        • peary/utils/lfsr.hpp
        • peary/utils/string_hash_map.hpp
        • peary/utils/utils.hpp
        • peary
        • peary::board
        • peary::board::carboard
        • peary::component
        • peary::config
        • peary::device
        • peary::hal
        • peary::interface
        • peary::log
        • peary::utils
        • peary::utils::dispatcher_impl
        • std
  • archive Archives
  • RSS
  • to navigate
  • to select
  • to close
    • Home
    • Peary Software
    • API
    On this page
    • Peary API Reference (Doxygen)
    • How to navigate
    • Peary API Reference (Doxygen)
    • How to navigate
    article

    API

    article folder

    Classes
    article folder

    Files
    article folder

    Namespaces

    © 2025 Caribou Project