EEprom Class Reference

#include <eeprom.h>

Public Member Functions
	EEprom ()
	Constructor Class. More...
	EEprom (TwoWire *wire, BinarySemaphore *wireLock, uint8_t i2c_address=EEPROM_AT24C64_DEFAULT_ADDRESS)
	Construct a new EEprom::EEprom object. More...
bool	Write (uint16_t address, uint8_t *buffer, uint16_t length)
	Write a number of data byte into EEPROM. More...
bool	Write (uint16_t address, uint8_t value)
	Write a number of data byte into EEPROM. More...
bool	Read (uint16_t address, uint8_t *buffer, uint16_t length)
	Read a number of data byte from EEPROM. More...
bool	Read (uint16_t address, uint8_t *value)
	Read a single byte from EEPROM. More...

Private Attributes
TwoWire *	_wire
BinarySemaphore *	_wireLock
uint8_t	_i2c_address

Detailed Description

Definition at line 49 of file eeprom.h.

Constructor & Destructor Documentation

EEprom() [1/2]

EEprom::EEprom

(

)

Constructor Class.

Definition at line 33 of file eeprom.cpp.

EEprom() [2/2]

EEprom::EEprom	(	TwoWire *	wire,
		BinarySemaphore *	wireLock,
		uint8_t	i2c_address = EEPROM_AT24C64_DEFAULT_ADDRESS
	)

Construct a new EEprom::EEprom object.

Parameters

wire	I2C class
wireLock	I2C semaphore
i2c_address	I2C address

Definition at line 41 of file eeprom.cpp.

Member Function Documentation

Read() [1/2]

bool EEprom::Read	(	uint16_t	address,
		uint8_t *	buffer,
		uint16_t	length
	)

Read a number of data byte from EEPROM.

Parameters

[in]	address	EEPROM data address
[in]	buffer	destination data buffer location
[in]	length	buffer length

Returns

true if success, otherwise false returned.

Definition at line 167 of file eeprom.cpp.

Read() [2/2]

bool EEprom::Read	(	uint16_t	address,
		uint8_t *	value
	)

Read a single byte from EEPROM.

Parameters

[in]	address	EEPROM data address
[in]	value	destination data buffer location

Returns

true if success, otherwise false returned.

Definition at line 133 of file eeprom.cpp.

Write() [1/2]

bool EEprom::Write	(	uint16_t	address,
		uint8_t *	buffer,
		uint16_t	length
	)

Write a number of data byte into EEPROM.

Parameters

[in]	address	EEPROM data address
[in]	buffer	source data buffer location
[in]	length	buffer length

Returns

true if success, otherwise false returned.

Definition at line 86 of file eeprom.cpp.

Write() [2/2]

bool EEprom::Write	(	uint16_t	address,
		uint8_t	value
	)

Write a number of data byte into EEPROM.

Parameters

[in]	address	EEPROM data address
[in]	value	data value to write

Returns

true if success, otherwise false returned.

Definition at line 52 of file eeprom.cpp.

Member Data Documentation

_i2c_address

uint8_t EEprom::_i2c_address

private

Definition at line 63 of file eeprom.h.

_wire

TwoWire* EEprom::_wire

private

Definition at line 61 of file eeprom.h.

_wireLock

BinarySemaphore* EEprom::_wireLock

private

Definition at line 62 of file eeprom.h.

---

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

• /home/pat1/git/rmap/platformio/stima_v4/slave-rain/include/drivers/eeprom.h
• /home/pat1/git/rmap/platformio/stima_v4/slave-rain/src/drivers/eeprom.cpp