pdsDataServer.h File Reference

The header file describes the interface of Persistence Data Server. More...

#include <configServer.h>

Go to the source code of this file.

Enumerations
enum	PDS_DataServerState_t {   PDS_SUCCESS, PDS_EEPROM_ERROR, PDS_CRC_ERROR, PDS_INVALID_REQUEST,   PDS_EEPROM_BUSY }
Functions
PDS_DataServerState_t	PDS_Init (void)
	Reads all parameters from EEPROM to Config Server memory.
PDS_DataServerState_t	PDS_SetToDefault (void)
	Writes default values of parameters to EEPROM.
PDS_DataServerState_t	PDS_ReadUserData (uint16_t offset, uint8_t *data, uint16_t length)
	Reads data from user area of EEPROM.
PDS_DataServerState_t	PDS_WriteUserData (uint16_t offset, uint8_t *data, uint16_t length, void(*callback)(void))
	Writes data to user area of EEPROM.

---

Detailed Description

The header file describes the interface of Persistence Data Server.

Definition in file pdsDataServer.h.

---

Enumeration Type Documentation

enum PDS_DataServerState_t

Enumerator:

PDS_SUCCESS	Command completed successfully
PDS_EEPROM_ERROR	EEPROM error occured
PDS_CRC_ERROR	Wrong CRC
PDS_INVALID_REQUEST	Some parameters are wrong
PDS_EEPROM_BUSY	EEPROM is busy

Definition at line 27 of file pdsDataServer.h.

---

Function Documentation

PDS_DataServerState_t PDS_Init

(

void

)

Reads all parameters from EEPROM to Config Server memory.

Reads all parameters from EEPROM to Config Server memory and also checks CRC of EEPROM stack parameters. In case of wrong CRC ConfigServer should reset EEPROM stack parameters to default values.

Returns:

- PDS state as a result of initiation.

PDS_DataServerState_t PDS_ReadUserData	(	uint16_t	offset,
		uint8_t *	data,
		uint16_t	length
	)

Reads data from user area of EEPROM.

Parameters:

[in]	offset	- data offset
[in]	data	- pointer to user data area
[in]	length	- data length

Returns:

- PDS state as a result of data reading operation

PDS_DataServerState_t PDS_SetToDefault

(

void

)

Writes default values of parameters to EEPROM.

Returns:

- PDS state as a result of setting parameters to default state

PDS_DataServerState_t PDS_WriteUserData	(	uint16_t	offset,
		uint8_t *	data,
		uint16_t	length,
		void(*)(void)	callback
	)

Writes data to user area of EEPROM.

Parameters:

[in]	offset	- data offset
[in]	data	- pointer to user data area
[in]	length	- data length

Returns:

- PDS state as a result of data writing operation

---