peary::component::Si5345

Si5345 Frequency Synthesizer Component.

#include <peary/hardware/components/Si5345.hpp>

Inherits from peary::hal::Component< interface::I2CEndpoint >

Public Types

Name
enum class Register { PAGE = 0x01}

Public Functions

Name
Si5345(const std::string & i2c_bus, uint8_t device_address)Constructor for Si5345 class.
void configure(const std::any & config)Configure the Si5345 with a given register configuration.
void disable()Disable the Si5345 by writing the CLKOFF register configuration.
interface::I2CEndpoint::vector_t read(int page)Read a page of registers from the Si5345.
bool isLocked()Check if the Si5345 has achieved lock.

Additional inherited members

Public Functions inherited from peary::hal::Component< interface::I2CEndpoint >

Name
template <typename… Args> requires std::constructible_from< Interface, Args… > Component(Args &&… args)Constructor which stores argument pack in a functional to generate the interface when accessed.
Component() =delete
virtual ~Component() =default
Interface & interface()Accessor function for the interface.

Public Types Documentation

enum Register

Enumerator Value Description
PAGE 0x01

Public Functions Documentation

function Si5345 

  Si5345(
    const std::string & i2c_bus,
    uint8_t device_address
)

Constructor for Si5345 class.

Parameters:

  • i2c_bus The I2C bus to which the Si5345 is connected
  • device_address The I2C address of the Si5345 device

function configure 

  void configure(
    const std::any & config
)

Configure the Si5345 with a given register configuration.

Parameters:

  • config A std::any object containing a vector of SI5345_REG_T structures

function disable 

  void disable()

Disable the Si5345 by writing the CLKOFF register configuration.

function read 

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

Read a page of registers from the Si5345.

Parameters:

  • page The page number to read

Return: A vector of register values read from the specified page

function isLocked 

  bool isLocked()

Check if the Si5345 has achieved lock.

Return: True if the Si5345 is locked, false otherwise

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