metadata::MetadataEditor Class Reference

#include <meta.h>

Inheritance diagram for metadata::MetadataEditor:

Collaboration diagram for metadata::MetadataEditor:

Public Member Functions
	MetadataEditor (bus::addr_t address, uint8_t alt_function_idx)
entities::EntityClassifier	read_entity_classifier () const
eui_t	read_eui () const
bool	write_entity_classifier (const entities::EntityClassifier &classifier) const
Public Member Functions inherited from functions::EEPROM25AA02
	EEPROM25AA02 (bus::addr_t address, uint8_t alt_function_idx)
Status	read_status_register () const
bool	write_status_register (const Status status) const
size_t	read (size_t address, size_t length, uint8_t *buffer) const
	Reads the specified number of bytes starting at address into the specified buffer. Returns number of read bytes on success, 0 on failure.
bool	read8 (size_t address, uint8_t *data_out) const
	Reads one byte at the specified address into the provided pointer. Returns 0 on failure.
bool	read16 (size_t address, uint16_t *data_out) const
	Reads two bytes starting at the specified address into the provided pointer. Returns 0 on failure.
bool	read32 (size_t address, uint32_t *data_out) const
	Reads four bytes starting at the specified address into the provided pointer. Returns 0 on failure.
size_t	write (size_t address, size_t length, const uint8_t *buffer) const
	Writes the specified number of bytes starting at address into the specified buffer. Returns number of written bytes on success, 0 on failure.
bool	write8 (size_t address, uint8_t data) const
	Writes one byte at the specified address Returns 0 on failure.
bool	write16 (size_t address, uint16_t data) const
	Writes two bytes starting at the specified address Returns 0 on failure.
bool	write32 (size_t address, uint32_t data) const
	Writes four bytes starting at the specified address Returns 0 on failure.
Public Member Functions inherited from functions::DataFunction
	DataFunction (bus::addr_t address, uint8_t alt_function_idx, const SPISettings &spiSettings)
void	begin_communication () const
void	end_communication () const
void	transfer (const void *mosi_buf, void *miso_buf, size_t count) const
uint8_t	transfer8 (uint8_t data_in) const
uint16_t	transfer16 (uint16_t data_in) const
uint32_t	transfer32 (uint32_t data_in) const
Public Member Functions inherited from functions::Function
	Function (bus::addr_t address)

Additional Inherited Members
Public Attributes inherited from functions::DataFunction
const SPISettings &	spi_settings
Public Attributes inherited from functions::Function
const bus::addr_t	address
Static Public Attributes inherited from functions::EEPROM25AA02
static const SPISettings	DEFAULT_SPI_SETTINGS {4'000'000, MSBFIRST, SPI_MODE0}
static constexpr uint8_t	ADDRESS_UUID = 0xF8
Protected Member Functions inherited from functions::EEPROM25AA02
void	set_write_enable () const
void	unset_write_enable () const
bool	await_write_complete () const
Static Protected Member Functions inherited from functions::EEPROM25AA02
static constexpr bool	_is_address_valid (size_t address)
Static Protected Member Functions inherited from functions::DataFunction
static SPIClass &	get_raw_spi ()
Protected Attributes inherited from functions::DataFunction
bus::addr_t	alt_function_address
bool	use_csel = false
Static Protected Attributes inherited from functions::EEPROM25AA02
static constexpr uint8_t	COMMAND_READ = 0b0000'0011
static constexpr uint8_t	COMMAND_READ_STATUS_REGISTER = 0b0000'0101
static constexpr uint8_t	COMMAND_WRITE = 0b0000'0010
static constexpr uint8_t	COMMAND_WRITE_STATUS_REGISTER = 0b0000'0001
static constexpr uint8_t	COMMAND_WRITE_ENABLE = 0b0000'0110
static constexpr uint8_t	COMMAND_WRITE_DISABLE = 0b0000'0100
static constexpr uint8_t	ADRESS_MASK = 0x0f
static constexpr size_t	MAX_ADDRESS = 255

Detailed Description

Definition at line 16 of file meta.h.

Constructor & Destructor Documentation

MetadataEditor()

metadata::MetadataEditor::MetadataEditor ( bus::addr_t address, uint8_t alt_function_idx )

inlineexplicit

Definition at line 18 of file meta.h.

References functions::EEPROM25AA02::EEPROM25AA02().

Member Function Documentation

read_entity_classifier()

entities::EntityClassifier metadata::MetadataEditor::read_entity_classifier ( ) const

inline

Definition at line 21 of file meta.h.

References functions::EEPROM25AA02::read().

read_eui()

eui_t metadata::MetadataEditor::read_eui ( ) const

inline

Definition at line 27 of file meta.h.

References functions::EEPROM25AA02::read().

write_entity_classifier()

bool metadata::MetadataEditor::write_entity_classifier ( const entities::EntityClassifier & classifier ) const

inline

Definition at line 33 of file meta.h.

References functions::EEPROM25AA02::write().

---

The documentation for this class was generated from the following file:

• lib/hardware/src/entity/meta.h