Public Member Functions
void	addUser (const char *phoneNum, uint16_t userGroup=1)
	Add user into Adeon. More...

void	deleteUser (const char *phoneNum)
	Delete user from Adeon. More...

void	deleteList ()
	Delete whole Adeon list. More...

char *	editUserPhone (const char actualPhoneNum, const char newPhoneNum)
	Edit user telephone number. More...

void	editUserRights (const char *phoneNum, uint16_t userGroup=1)
	Edit user rights. More...

bool	isUserInAdeon (const char *phoneNum)
	Check if user is in Adeon. More...

uint8_t	getNumOfUsers ()
	Get number of users in a list. More...

uint16_t	getUserRightsLevel (const char *phoneNum)
	Get user rights value. More...

void	printUsers ()
	Print content of the user list. More...

void	addParam (const char *pName, uint16_t val=1)
	Add parameter into Adeon. More...

void	addParamWithCallback (void(callback)(uint16_t), const char pName, uint16_t val=1)
	Add parameter into Adeon. More...

void	setParamAccess (const char *pName, uint8_t access)
	Set parameter access rights. More...

void	deleteParam (const char *pName)
	Delete parameter from Adeon. More...

char *	editParamName (const char pActualName, const char pNewName)
	Edit parameter name. More...

void	editParamValue (const char *pName, uint16_t val=1)
	Edit parameter value. More...

bool	isParamInAdeon (const char *pName)
	Check if parameter is in Adeon. More...

uint8_t	getNumOfParams ()
	Get number of parameters in a list. More...

uint16_t	getParamValue (const char *pName)
	Get parameter value. More...

void	printParams ()
	Print content of the parameter list. More...

void	parseBuf (const char *pMsg, uint8_t userGroup)
	Call parsing process of a message. More...

bool	isAdeonReady ()
	Check if Adeon is ready for incoming message. More...

Detailed Description

Definition at line 43 of file AdeonGSM.h.

Member Function Documentation

◆ addParam()

void Adeon::addParam	(	const char *	pName,
		uint16_t	val = `1`
	)

Add parameter into Adeon.

Parameters

pName	is pointer to name constant string.
val	is variable which defines value of parameter.

Definition at line 108 of file AdeonGSM.cpp.

◆ addParamWithCallback()

void Adeon::addParamWithCallback	(	void(*)(uint16_t)	callback,
		const char *	pName,
		uint16_t	val = `1`
	)

Add parameter into Adeon.

Parameters

pName	is pointer to name constant string.
val	is variable which defines value of parameter.
*callback	is function callback which is triggered after changing

Definition at line 118 of file AdeonGSM.cpp.

◆ addUser()

void Adeon::addUser	(	const char *	phoneNum,
		uint16_t	userGroup = `1`
	)

Add user into Adeon.

Parameters

phoneNum	is pointer to telephone number constant string.
userGroup	is variable which defines user rights.

Definition at line 30 of file AdeonGSM.cpp.

◆ deleteList()

void Adeon::deleteList ( )

Delete whole Adeon list.

Definition at line 45 of file AdeonGSM.cpp.

◆ deleteParam()

void Adeon::deleteParam ( const char * pName )

Delete parameter from Adeon.

Parameters

pName is pointer to name constant string.

Definition at line 136 of file AdeonGSM.cpp.

◆ deleteUser()

void Adeon::deleteUser ( const char * phoneNum )

Delete user from Adeon.

Parameters

phoneNum is pointer to telephone number constant string.

Definition at line 38 of file AdeonGSM.cpp.

◆ editParamName()

char * Adeon::editParamName	(	const char *	pActualName,
		const char *	pNewName
	)

Edit parameter name.

Parameters

pActualName	is pointer to actual name constant string.
pNewName	is pointer to new name constant string.

Definition at line 145 of file AdeonGSM.cpp.

◆ editParamValue()

void Adeon::editParamValue	(	const char *	pName,
		uint16_t	val = `1`
	)

Edit parameter value.

Parameters

pName	is pointer to name constant string.
val	is variable which defines new value of parameter.

Definition at line 154 of file AdeonGSM.cpp.

◆ editUserPhone()

char * Adeon::editUserPhone	(	const char *	actualPhoneNum,
		const char *	newPhoneNum
	)

Edit user telephone number.

Parameters

actualPhoneNum	is a pointer to actual telephone number constant string.
newPhoneNum	is pointer to new telephone number constant string.

Definition at line 54 of file AdeonGSM.cpp.

◆ editUserRights()

void Adeon::editUserRights	(	const char *	phoneNum,
		uint16_t	userGroup = `1`
	)

Edit user rights.

Parameters

phoneNum	is pointer to telephone number constant string.
userGroup	is variable which defines user rights.

Definition at line 63 of file AdeonGSM.cpp.

◆ getNumOfParams()

uint8_t Adeon::getNumOfParams ( )

Get number of parameters in a list.

Returns: userList->getNumOfItems() - return value is number of parameters in the list.

Definition at line 171 of file AdeonGSM.cpp.

◆ getNumOfUsers()

uint8_t Adeon::getNumOfUsers ( )

Get number of users in a list.

Returns: userList->getNumOfItems() - return value is number of users in the list.

Definition at line 80 of file AdeonGSM.cpp.

◆ getParamValue()

uint16_t Adeon::getParamValue ( const char * pName )

Get parameter value.

Parameters

pName is pointer to name constant string.

Returns: paramList->getItemVal(paramList->findItem(pName)); - return value is parameter value.

Definition at line 180 of file AdeonGSM.cpp.

◆ getUserRightsLevel()

uint16_t Adeon::getUserRightsLevel ( const char * phoneNum )

Get user rights value.

Parameters

phoneNum is pointer to telephone number constant string.

Returns: userList->getItemVal(userList->findItem(phoneNum)) - return value is user rights value.

Definition at line 89 of file AdeonGSM.cpp.

◆ isAdeonReady()

bool Adeon::isAdeonReady ( )

Check if Adeon is ready for incoming message.

Returns: _ready true if Adeon is ready, false otherwise.

Definition at line 230 of file AdeonGSM.cpp.

◆ isParamInAdeon()

bool Adeon::isParamInAdeon ( const char * pName )

Check if parameter is in Adeon.

Parameters

pName is pointer to name constant string.

Returns: paramList->isInList(paramList->findItem(pName)) true if parameter is in the list, false otherwise.

Definition at line 163 of file AdeonGSM.cpp.

◆ isUserInAdeon()

bool Adeon::isUserInAdeon ( const char * phoneNum )

Check if user is in Adeon.

Parameters

phoneNum is pointer to telephone number constant string.

Returns: userList->isInList(userList->findItem(phoneNum)) true if user is in the list, false otherwise.

Definition at line 72 of file AdeonGSM.cpp.

◆ parseBuf()

void Adeon::parseBuf	(	const char *	pMsg,
		uint8_t	userGroup
	)

Call parsing process of a message.

Parameters

pMsg	is pointer to incoming message.

Check if message length is valid and if parser is ready.
Set Adeon state to false and copy message into internal Adeon buffer.
Check if message is valid (validity of hash and symbols order).
Parse parameter names and values until all received data has been processed.
Set Adeon state to true.

Definition at line 204 of file AdeonGSM.cpp.

◆ printParams()

void Adeon::printParams ( )

Print content of the parameter list.

It calls method of ItemList class. To carry out this metod is necessary to initialize serial terminal in setup (Serial.begin).

Definition at line 190 of file AdeonGSM.cpp.

◆ printUsers()

void Adeon::printUsers ( )

Print content of the user list.

It calls method of ItemList class. To carry out this metod is necessary to initialize serial terminal in setup (Serial.begin).

Definition at line 99 of file AdeonGSM.cpp.

◆ setParamAccess()

void Adeon::setParamAccess	(	const char *	pName,
		uint8_t	access
	)

Set parameter access rights.

Parameters

pName	is pointer to name constant string.
access	is variable which defines user access level to parameter. Default access rights for parameter is level ADMIN

Definition at line 128 of file AdeonGSM.cpp.

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

src/AdeonGSM.h
src/AdeonGSM.cpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ addParam()

◆ addParamWithCallback()

◆ addUser()

◆ deleteList()

◆ deleteParam()

◆ deleteUser()

◆ editParamName()

◆ editParamValue()

◆ editUserPhone()

◆ editUserRights()

◆ getNumOfParams()

◆ getNumOfUsers()

◆ getParamValue()

◆ getUserRightsLevel()

◆ isAdeonReady()

◆ isParamInAdeon()

◆ isUserInAdeon()

◆ parseBuf()

◆ printParams()

◆ printUsers()

◆ setParamAccess()