peary::board::carboard::ClockGenerator

Clock generator resource for CaR board.

#include <peary/hardware/boards/Carboard.hpp>

Inherits from peary::hal::ClockSynthesizer, peary::hal::Resource

Public Functions

Name
ClockGenerator(component::Si5345 & si5345)Constructor for ClockGenerator class.
virtual void configure(const std::any & config) overrideConfigure the clock generator with the given configuration.
virtual void disable() overrideDisable the clock generator.
virtual bool isLocked() overrideCheck if the clock generator is locked.
interface::I2CEndpoint::vector_t read(int page)Read a page of configuration data from the clock generator.

Additional inherited members

Public Functions inherited from peary::hal::Resource

Name
virtual ~Resource() =defaultDefault constructor.
void setName(std::string_view name)Set the name of the resource, usually corresponds to the name used in the schematic.
std::string name() constGet the name of the resource.
void setType(std::string_view type)Set the type string (e.g. VoltageRegulator)
std::string type() constGet the type of the resource.

Protected Attributes inherited from peary::hal::Resource

Name
std::string _name
std::string _type

Public Functions Documentation

function ClockGenerator 

  inline ClockGenerator(
    component::Si5345 & si5345
)

Constructor for ClockGenerator class.

Parameters:

  • si5345 Reference to the Si5345 component

function configure 

  inline virtual void configure(
    const std::any & config
) override

Configure the clock generator with the given configuration.

Parameters:

  • config The configuration object

Reimplements: peary::hal::ClockSynthesizer::configure

function disable 

  inline virtual void disable() override

Disable the clock generator.

Reimplements: peary::hal::ClockSynthesizer::disable

function isLocked 

  inline virtual bool isLocked() override

Check if the clock generator is locked.

Return: True if the clock generator is locked, false otherwise

Reimplements: peary::hal::ClockSynthesizer::isLocked

function read 

  inline interface::I2CEndpoint::vector_t read(
    int page
)

Read a page of configuration data from the clock generator.

Parameters:

  • page The page number to read

Return: A vector containing the data read from the specified page

Updated on 2026-01-30 at 22:01:05 +0100