Parameter-Interface for connection with a PC. More...

#include "SYS_Type.h"
#include "cmsis_compiler.h"

Data Structures
struct	Group
	Parameter-group. More...

struct	Parameter
	Parameter definition. More...

struct	Parameter_InfoHeader
	Information structure to identify one parameter in some functions. More...

struct	ParaData_I8
	Parameter-data structure for signed char (8-Bit) More...

struct	ParaData_U8
	Parameter-data structure for unsigned char (8-Bit) More...

struct	ParaData_I16
	Parameter-data structure for signed word (16-Bit) More...

struct	ParaData_U16
	Parameter-data structure for unsigned word (16-Bit) More...

struct	ParaData_I32
	Parameter-data structure for signed int (32-Bit) More...

struct	ParaData_U32
	Parameter-data structure for unsigned int (32-Bit) More...

struct	ParaData_I64
	Parameter-data structure for signed long (64-Bit) More...

struct	ParaData_U64
	Parameter-data structure for unsigned long (64-Bit) More...

struct	ParaData_F32
	Parameter-data structure for float (32-Bit) More...

struct	ParaData_F64
	Parameter-data structure for double (64-Bit) More...

struct	ParaData_STR
	Parameter-data structure for string. More...

Macros
#define	static_assert _Static_assert

#define	DEFINE_VAL(s) DEFINE_STR(s)
	Macro to reference a defined value in helptexts. More...

#define	PARA(s) PARA_STR(s)
	Macro to reference a parameter in helptexts. More...

#define	ERROR(s) ERROR_STR(s)
	Macro to reference an error in helptexts. More...

#define	ParameterF32(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MIN, MAX, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an 32 bit floating point parameter. More...

#define	ParameterU32(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MIN, MAX, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an 32 bit unsigned integer parameter. More...

#define	ParameterI32(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MIN, MAX, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an 32 bit signed integer parameter. More...

#define	ParameterU16(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MIN, MAX, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an 16 bit unsigned integer parameter. More...

#define	ParameterI16(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MIN, MAX, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an 16 bit signed integer parameter. More...

#define	ParameterU8(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MIN, MAX, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an 8 bit unsigned integer parameter. More...

#define	ParameterI8(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MIN, MAX, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an 8 bit signed integer parameter. More...

#define	ParameterSTR(VARIABLE_NAME, PARA_ID, GROUP_ID, NAME, UNIT, DESCRIPTION, HELP_EN, HELP_DE, SUBSTITUTION, COUNT, MAX_LENGTH, DEFAULT, ON_READ, ON_WRITE, SET_TO_DEFAULT, ACCESS, STORE_LOCATION, FLAGS)
	Defines an string parameter. More...

#define	Parameter(PARA_ID) g_tParameter##PARA_ID
	Use to declare an Parameter as external. More...

#define	ParameterWriteF32(PARA_ID, SUB_ID, DATA, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 4, 0, ACCESS_SOURCE, ACCESS_LEVEL)
	Use to write to a 32Bit float Parameter within the source code. More...

#define	ParameterWriteU32(PARA_ID, SUB_ID, DATA, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 4, 0, ACCESS_SOURCE, ACCESS_LEVEL)
	Use to write to a 32Bit unsigned Parameter within the source code. More...

#define	ParameterWriteI32(PARA_ID, SUB_ID, DATA, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 4, 0, ACCESS_SOURCE, ACCESS_LEVEL)
	Use to write to a 32Bit signed Parameter within the source code. More...

#define	ParameterWriteU16(PARA_ID, SUB_ID, DATA, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 2, 0, ACCESS_SOURCE, ACCESS_LEVEL)
	Use to write to a 16Bit unsigned Parameter within the source code. More...

#define	ParameterWriteI16(PARA_ID, SUB_ID, DATA, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 2, 0, ACCESS_SOURCE, ACCESS_LEVEL)
	Use to write to a 16Bit signed Parameter within the source code. More...

#define	ParameterWriteU8(PARA_ID, SUB_ID, DATA, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 1, 0, ACCESS_SOURCE, ACCESS_LEVEL)
	Use to write to a 8Bit unsigned Parameter within the source code. More...

#define	ParameterWriteI8(PARA_ID, SUB_ID, DATA, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 1, 0, ACCESS_SOURCE, ACCESS_LEVEL)
	Use to write to a Bit signed Parameter within the source code. More...

#define	ParameterSetToDefaultF32(PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);
	Use to set a 32Bit floating point Parameter within the source code to the default value. More...

#define	ParameterSetToDefaultU32(PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);
	Use to set a 32Bit unsigned Parameter within the source code to the default value. More...

#define	ParameterSetToDefaultI32(PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);
	Use to set a 32Bit signed Parameter within the source code to the default value. More...

#define	ParameterSetToDefaultU16(PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);
	Use to set a 16Bit unsigned Parameter within the source code to the default value. More...

#define	ParameterSetToDefaultI16(PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);
	Use to set a 16Bit signed Parameter within the source code to the default value. More...

#define	ParameterSetToDefaultU8(PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);
	Use to set a 8Bit unsigned Parameter within the source code to the default value. More...

#define	ParameterSetToDefaultI8(PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL) g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);
	Use to set a 8Bit signed Parameter within the source code to the default value. More...

#define	GetStorageLocation(Parameter) (((Parameter)->Flags >> 24) & 0x0F)
	Get Storage Location from Parameter This macro is used to extract the storage location out of a parameter structure. More...

#define	GetDataType(Parameter) ((Parameter)->Flags >> 28)
	Get Datatype from Parameter This macro is used to extract the datatype out of a parameter structure. More...

Typedefs
typedef int32_t	ReadFunction(void ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

typedef int32_t	WriteFunction(void ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

typedef int32_t	RestoreDefaultFunction(void *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

Enumerations
enum	ParameterAccessSource { PARA_ACCESS_FROM_CODE , PARA_ACCESS_FROM_GUEST , PARA_ACCESS_FROM_USB , PARA_ACCESS_FROM_ETHERNET , PARA_ACCESS_FROM_HESP , PARA_ACCESS_FROM_CAN }
	List of sources for parameter-access. Every parameter can limit access to these sources. (see Access restrictions). More...

enum	ACCESS_LEVEL { ACCESS_NONE = 0x00 , ACCESS_VIEWER = 0x01 , ACCESS_USER = 0x02 , ACCESS_PROFESSIONAL = 0x03 , ACCESS_DEVELOPER = 0x04 , ACCESS_PLC = 0x05 , ACCESS_SPECIAL1 = 0x06 , ACCESS_SPECIAL2 = 0x07 , ACCESS_SPECIAL3 = 0x08 }
	List of access-levels for parameters. Every parameter can limit read and write access according to these levels. (see Access restrictions). More...

enum	ZUGRIFF { VIEWER_READ = 0x0001 , VIEWER_WRITE = 0x0002 , USER_READ = 0x0004 , USER_WRITE = 0x0008 , PROFESSIONAL_READ = 0x0010 , PROFESSIONAL_WRITE = 0x0020 , DEVELOPER_READ = 0x0040 , DEVELOPER_WRITE = 0x0080 , PLC_READ = 0x0100 , PLC_WRITE = 0x0200 , SPECIAL1_READ = 0x0400 , SPECIAL1_WRITE = 0x0800 , SPECIAL2_READ = 0x1000 , SPECIAL2_WRITE = 0x2000 , SPECIAL3_READ = 0x4000 , SPECIAL3_WRITE = 0x8000 }
	List of access restrictions for parameters. Every parameter can limit read and write access according to these levels. (see Access restrictions). More...

enum	STORE_LOCATION { NOT_STORED = 0 , PARA_FLASH = 1 , NVRAM = 2 , EEPROM = 3 , EXT_FLASH = 4 , SD_BASE = 5 , FACTORY_FLASH = 6 , SD = 7 , FACTORY_EEPROM = 8 }
	List of storage locations for parameters. More...

enum	GET_VALUES { GET_MIN = 1 , GET_MAX = 2 , GET_DEFAULT = 3 }
	List of values, that can be retrived with the GetParaDataAsObject function. More...

enum	FLAGS { FLAG_NONE = 0x00000000 , FLAG_SYSTEM = 0x00000001 , FLAG_HIDDEN = 0x00000002 , FLAG_SCOPEABLE = 0x00000004 , FLAG_VOLATILE = 0x00000008 , FLAG_NO_FILE_OVERWRITE = 0x00000010 , FLAG_WRITE_APPROVE_REQUEST = 0x00000020 , FLAG_SPECIAL_WRITE_ENABLE = 0x00000020 }
	List of Flags, which can be set for every single parameter First 8 Bits cannot be used, they are occupied by Storage Location and Datatype. More...

Functions
uint32_t	GetParameterCount (void)
	Get the number of the existent parameters. More...

uint32_t	GetGroupCount (void)
	Get the number of the existent parameter-groups. More...

Parameter *	GetParameter (uint32_t ParaID)
	Get the parameter of the given ID. More...

Group *	GetGroup (uint32_t GroupID)
	Get the parameter-Group of the given ID. More...

int32_t	GetDataTypeSize (uint8_t Type)
	Calculate the Size of a parameter-type. More...

uint32_t	GetStringParameterLength (Parameter *p, uint16_t subID)
	Get the length of the string data of the given parameter. More...

int32_t	StreamReadParameterData_Value (Parameter_InfoHeader info, uint8_t destination, int32_t MaxCount, uint32_t offset, ParameterAccessSource Access, uint8_t AccessLevel)
	Read Parameter-data into buffer (Variant 1) The Data of the selected parameter is read and stored into a given buffer address. More...

int32_t	StreamReadParameterData_Value2 (Parameter p, uint16_t subID, unsigned char destination, int MaxCount, uint32_t offset, ParameterAccessSource Access, unsigned char AccessLevel)
	Read Parameter-data into buffer (Variant 2) The Data of the selected parameter is read and stored into a given buffer address. More...

int32_t	StreamWriteParameterData_Value (Parameter_InfoHeader info, unsigned char source, uint32_t offset, ParameterAccessSource Access, unsigned char AccessLevel)

int32_t	StreamWriteParameterData_Value2 (Parameter p, uint16_t subID, unsigned char source, uint32_t offset, ParameterAccessSource Access, unsigned char AccessLevel, uint16_t count)
	Write Parameter-data from buffer (Variant 2) The Data of the given buffer is written to parameter. More...

int32_t	StreamWriteStringParameter (Parameter p, uint16_t StartSubID, uint16_t count, unsigned char destination, uint32_t *MaxCount, ParameterAccessSource Access, unsigned char AccessLevel)
	Read String Parameter-data into buffer (Variant 1) The Data of the selected string-parameter is read and stored into a given buffer address. More...

int32_t	StreamWriteStringParameter2 (Parameter p, uint16_t StartSubID, uint16_t count, unsigned char destination, uint32_t MaxCount, ParameterAccessSource Access, unsigned char AccessLevel, unsigned int StrPos)
	Read String Parameter-data into buffer (Variant 2) The Data of the selected string-parameter is read and stored into a given buffer address. More...

int32_t	PARA_ValAsString (Parameter p, int32_t SubId, char dest, int32_t MaxLength, uint8_t AccessLevel)
	Output the parameter value as formatted string. More...

int32_t	PARA_ObjectToString (Parameter p, object data, char *dest, int32_t MaxLength)
	Parse Parameter-data out of an object. More...

int32_t	PARA_ParseString (Parameter p, int32_t SubId, char input, uint8_t AccessLevel)
	Parse Parameter-data out of an input string. More...

int32_t	ReadFunction_STD_I8 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for signed char datatype. More...

int32_t	ReadFunction_STD_I16 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for signed word (16-Bit) datatype. More...

int32_t	ReadFunction_STD_I32 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for signed int (32-Bit) datatype. More...

int32_t	ReadFunction_STD_I64 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for signed int (64-Bit) datatype. More...

int32_t	ReadFunction_STD_U8 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for unsigned char datatype. More...

int32_t	ReadFunction_STD_U8_BitWise (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for unsigned char datatype as bit-array. More...

int32_t	ReadFunction_STD_U16 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for unsigned word (16-Bit) datatype. More...

int32_t	ReadFunction_STD_U32 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for unsigned int (32-Bit) datatype. More...

int32_t	ReadFunction_STD_U64 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for unsigned long int (64-Bit) datatype. More...

int32_t	ReadFunction_STD_F32 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for float (32-Bit) datatype. More...

int32_t	ReadFunction_STD_STR (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default read-function for string datatype. More...

int32_t	WriteFunction_STD_I8 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for signed char datatype. More...

int32_t	WriteFunction_STD_I16 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for signed word (16-Bit) datatype. More...

int32_t	WriteFunction_STD_I32 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for signed int (32-Bit) datatype. More...

int32_t	WriteFunction_STD_I64 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for signed long int (64-Bit) datatype. More...

int32_t	WriteFunction_STD_U8 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for unsigned char datatype. More...

int32_t	WriteFunction_STD_U8_BitWise (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for unsigned char datatype as bit-array. More...

int32_t	WriteFunction_STD_U16 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for unsigned word (16-Bit) datatype. More...

int32_t	WriteFunction_STD_U32 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for unsigned int (32-Bit) datatype. More...

int32_t	WriteFunction_STD_U64 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for unsigned long int (64-Bit) datatype. More...

int32_t	WriteFunction_STD_F32 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for float (32-Bit) datatype. More...

int32_t	WriteFunction_STD_STR (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for string datatype. More...

int32_t	WriteFunction_STD_Const (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default write-function for not writeable parameters. More...

int32_t	SetToDefaultFunction_STD_I8 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for signed char datatype. More...

int32_t	SetToDefaultFunction_STD_I16 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for signed word (16-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_I32 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for signed int (32-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_I64 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for signed long int (64-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_U8 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for unsigned char datatype. More...

int32_t	SetToDefaultFunction_STD_U8_BitWise (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for signed char datatype as bit-array. More...

int32_t	SetToDefaultFunction_STD_U16 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for nsigned word (16-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_U32 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for unsigned int (32-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_U64 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for unsigned long int (64-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_F32 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for float (32-Bit) datatype. More...

int32_t	SetToDefaultFunction_STD_STR (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default setToDefault-function for string datatype. More...

int32_t	SetToDefaultFunction_STD_Const (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Default SetToDefault-function for not writeable parameters. More...

bool	IsValidForRead (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Check if the actual access-right is sufficient to read the parameter. More...

bool	IsValidForWrite (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Check if the actual access-right is sufficient to write the parameter. More...

bool	IsValidForSetToDefault (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)
	Check if the actual access-right is sufficient to set to default the parameter. More...

int32_t	ReadFunction_STD_I32Q16 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

int32_t	WriteFunction_STD_I32Q16 (Parameter ptThis, uint16_t ui16SubId, void pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

int32_t	SetToDefaultFunction_STD_I32Q16 (Parameter *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

void	GetParaDataAsObject (Parameter p, uint32_t data, object ob, uint8_t AccessLevel)
	Get Parameter-data as object type. More...

void	GetParaValueAsObject (Parameter p, uint16_t SubId, object ob, uint8_t AccessLevel)
	Get Parameter-value as object type. More...

float	ObjToFloat32 (object *ob)
	Convertrs a given object to float. More...

Variables
int32_t	ANZAHL_PARAMETER
	Number of existent parameters. Must be defined in main program. More...

const int32_t	ANZAHL_GRUPPEN
	Number of existent parameter-groups. Must be defined in main program. More...

Parameter *	ParaListe
	List of all existent parameters in device. The list is filled by the linker automatically. More...

const Group *	GruppenListe []
	List of all existent parameter-groups in device. The list is filled by the paraInit function. More...

uint8_t	g_ui8ActualAccessLevel
	Actual access-level (see Access restrictions). More...

uint8_t *	g_pui8ActualAccessLevelPointer
	Pointer to the Actual access-level (see Access restrictions). More...

uint16_t	g_ui16FlashModified
	Flag to show if the remanent storage is modified. More...

Detailed Description

Parameter-Interface for connection with a PC.

Headerfile with all Prototypes.

Macro Definition Documentation

◆ DEFINE_VAL

#define DEFINE_VAL ( s ) DEFINE_STR(s)

Macro to reference a defined value in helptexts.

◆ ERROR

#define ERROR ( s ) ERROR_STR(s)

Macro to reference an error in helptexts.

◆ GetDataType

#define GetDataType ( Parameter ) ((Parameter)->Flags >> 28)

Get Datatype from Parameter This macro is used to extract the datatype out of a parameter structure.

Parameters

Parameter Parameter to extract type

◆ GetStorageLocation

#define GetStorageLocation ( Parameter ) (((Parameter)->Flags >> 24) & 0x0F)

Get Storage Location from Parameter This macro is used to extract the storage location out of a parameter structure.

Parameters

Parameter Parameter to extract location

◆ PARA

#define PARA ( s ) PARA_STR(s)

Macro to reference a parameter in helptexts.

◆ Parameter

#define Parameter ( PARA_ID ) g_tParameter##PARA_ID

Use to declare an Parameter as external.

This macro is used in header-files to allow using the defined Parameter from several modules.

Parameters

PARA_ID Identifier of the defined parameter.

◆ ParameterF32

#define ParameterF32	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MIN,
		MAX,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Value:

                                                                                                                                          \
const ParaData_F32 g_tParaData_##PARA_ID = {                                                                                              \
VARIABLE_NAME,                                                                                                                            \
MIN,                                                                                                                                      \
MAX,                                                                                                                                      \
DEFAULT                                                                                                                                   \
};                                                                                                                                        \
                                                                                                                                          \
static const char g_sParaName##PARA_ID[]              __attribute__((section("para_strings"), used)) = NAME;                              \
static const char g_sParaUnit##PARA_ID[]              __attribute__((section("para_strings"), used)) = UNIT;                              \
static const char g_sParaSubstitutionText##PARA_ID[]  __attribute__((section("para_strings"), used)) = SUBSTITUTION;                      \
static const char g_sParaDescription##PARA_ID[]       __attribute__((section("para_strings"), used)) =                                    \
DESCRIPTION PARA_HELP_TEXT_COMBINE(INCLUDE_HELP_EN("DOC_E " HELP_EN) INCLUDE_HELP_DE("DOC_D " HELP_DE));                                  \
PARA_HELP_TEXT_SECTION(PARA_ID, PARA_HELP_TEXT_COMBINE(INCLUDE_HELP_EN("DOC_E " HELP_EN) INCLUDE_HELP_DE("DOC_D " HELP_DE)))              \
                                                                                                                                          \
const Parameter g_tParameter##PARA_ID __attribute__((section("para_descriptor"))) = {                                                     \
GROUP_ID,                                                                                                                                 \
PARA_ID,                                                                                                                                  \
ACCESS,                                                                                                                                   \
COUNT,                                                                                                                                    \
g_sParaName##PARA_ID,                                                                                                                     \
g_sParaDescription##PARA_ID,                                                                                                              \
g_sParaUnit##PARA_ID,                                                                                                                     \
(void*)&g_tParaData_##PARA_ID,                                                                                                            \
(ReadFunction*)ON_READ,                                                                                                                   \
(WriteFunction*)ON_WRITE,                                                                                                                 \
(RestoreDefaultFunction*)SET_TO_DEFAULT,                                                                                                  \
(STORE_LOCATION << 24) | ((uint32_t)TYPE_float << 28) | FLAGS,                                                                            \
g_sParaSubstitutionText##PARA_ID,                                                                                                         \
};

Defines an 32 bit floating point parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MIN	Minimum value
MAX	Maximum value
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterI16

#define ParameterI16	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MIN,
		MAX,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Defines an 16 bit signed integer parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MIN	Minimum value
MAX	Maximum value
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterI32

#define ParameterI32	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MIN,
		MAX,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Defines an 32 bit signed integer parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MIN	Minimum value
MAX	Maximum value
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterI8

#define ParameterI8	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MIN,
		MAX,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Defines an 8 bit signed integer parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MIN	Minimum value
MAX	Maximum value
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterSetToDefaultF32

#define ParameterSetToDefaultF32	(	PARA_ID,
		SUB_ID,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);

Use to set a 32Bit floating point Parameter within the source code to the default value.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be set to default
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterSetToDefaultI16

#define ParameterSetToDefaultI16	(	PARA_ID,
		SUB_ID,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);

Use to set a 16Bit signed Parameter within the source code to the default value.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be set to default
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterSetToDefaultI32

#define ParameterSetToDefaultI32	(	PARA_ID,
		SUB_ID,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);

Use to set a 32Bit signed Parameter within the source code to the default value.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be set to default
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterSetToDefaultI8

#define ParameterSetToDefaultI8	(	PARA_ID,
		SUB_ID,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);

Use to set a 8Bit signed Parameter within the source code to the default value.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be set to default
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterSetToDefaultU16

#define ParameterSetToDefaultU16	(	PARA_ID,
		SUB_ID,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);

Use to set a 16Bit unsigned Parameter within the source code to the default value.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be set to default
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterSetToDefaultU32

#define ParameterSetToDefaultU32	(	PARA_ID,
		SUB_ID,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);

Use to set a 32Bit unsigned Parameter within the source code to the default value.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be set to default
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterSetToDefaultU8

#define ParameterSetToDefaultU8	(	PARA_ID,
		SUB_ID,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.SetToDefault((void*)&g_tParameter##PARA_ID, SUB_ID, ACCESS_SOURCE, ACCESS_LEVEL);

Use to set a 8Bit unsigned Parameter within the source code to the default value.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be set to default
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterSTR

#define ParameterSTR	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MAX_LENGTH,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Defines an string parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MAX_LENGTH	Maximum string length
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterU16

#define ParameterU16	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MIN,
		MAX,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Defines an 16 bit unsigned integer parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MIN	Minimum value
MAX	Maximum value
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterU32

#define ParameterU32	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MIN,
		MAX,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Defines an 32 bit unsigned integer parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MIN	Minimum value
MAX	Maximum value
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterU8

#define ParameterU8	(	VARIABLE_NAME,
		PARA_ID,
		GROUP_ID,
		NAME,
		UNIT,
		DESCRIPTION,
		HELP_EN,
		HELP_DE,
		SUBSTITUTION,
		COUNT,
		MIN,
		MAX,
		DEFAULT,
		ON_READ,
		ON_WRITE,
		SET_TO_DEFAULT,
		ACCESS,
		STORE_LOCATION,
		FLAGS
	)

Defines an 8 bit unsigned integer parameter.

Parameters

VARIABLE_NAME	Pointer to Data value
PARA_ID	Unique identifier of the parameter
GROUP_ID	Identifier of a parameter group. See page Grouping of parameters
NAME	Name of the parameter. It is shown in the list of parameters
UNIT	Format of the parameter-value. See page Customized format of parameter values.
DESCRIPTION	Description. It is shown in the list of parameters
HELP_EN	English Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
HELP_DE	German Help-text of the parameter. It is shown in the bottom left corner of the parameter editor. See page Help-page for a parameter
SUBSTITUTION	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.
COUNT	Number of entries in case of a data-field
MIN	Minimum value
MAX	Maximum value
DEFAULT	Factory default value
ON_READ	user-defined read-function, see page User defined onRead and onWrite functions.
ON_WRITE	user-defined write-function, see page User defined onRead and onWrite functions.
SET_TO_DEFAULT	user-defined restore-function, see page User defined onRead and onWrite functions.
ACCESS	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions
STORE_LOCATION	location if the parameter value is stored to nv-ram, see page Storage of parameter-values in a non volatile memory.
FLAGS	special flag, see page Special flags for parameters.

◆ ParameterWriteF32

#define ParameterWriteF32	(	PARA_ID,
		SUB_ID,
		DATA,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 4, 0, ACCESS_SOURCE, ACCESS_LEVEL)

Use to write to a 32Bit float Parameter within the source code.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be written
DATA	Pointer to the data source
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterWriteI16

#define ParameterWriteI16	(	PARA_ID,
		SUB_ID,
		DATA,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 2, 0, ACCESS_SOURCE, ACCESS_LEVEL)

Use to write to a 16Bit signed Parameter within the source code.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be written
DATA	Pointer to the data source
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterWriteI32

#define ParameterWriteI32	(	PARA_ID,
		SUB_ID,
		DATA,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 4, 0, ACCESS_SOURCE, ACCESS_LEVEL)

Use to write to a 32Bit signed Parameter within the source code.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be written
DATA	Pointer to the data source
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterWriteI8

#define ParameterWriteI8	(	PARA_ID,
		SUB_ID,
		DATA,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 1, 0, ACCESS_SOURCE, ACCESS_LEVEL)

Use to write to a Bit signed Parameter within the source code.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be written
DATA	Pointer to the data source
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterWriteU16

#define ParameterWriteU16	(	PARA_ID,
		SUB_ID,
		DATA,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 2, 0, ACCESS_SOURCE, ACCESS_LEVEL)

Use to write to a 16Bit unsigned Parameter within the source code.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be written
DATA	Pointer to the data source
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterWriteU32

#define ParameterWriteU32	(	PARA_ID,
		SUB_ID,
		DATA,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 4, 0, ACCESS_SOURCE, ACCESS_LEVEL)

Use to write to a 32Bit unsigned Parameter within the source code.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be written
DATA	Pointer to the data source
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ ParameterWriteU8

#define ParameterWriteU8	(	PARA_ID,
		SUB_ID,
		DATA,
		ACCESS_SOURCE,
		ACCESS_LEVEL
	)	g_tParameter##PARA_ID.OnWrite((void)&g_tParameter##PARA_ID, SUB_ID, (void)DATA, 1, 0, ACCESS_SOURCE, ACCESS_LEVEL)

Use to write to a 8Bit unsigned Parameter within the source code.

Parameters

PARA_ID	Identifier of the defined parameter.
SUB_ID	SubId the sould be written
DATA	Pointer to the data source
ACCESS_SOURCE	One of a ParameterAccessSource
ACCESS_LEVEL	One of a ACCESS_LEVEL

◆ static_assert

#define static_assert _Static_assert

Typedef Documentation

◆ ReadFunction

typedef int32_t ReadFunction(void *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

◆ RestoreDefaultFunction

typedef int32_t RestoreDefaultFunction(void *ptThis, uint16_t ui16SubId, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

◆ WriteFunction

typedef int32_t WriteFunction(void *ptThis, uint16_t ui16SubId, void *pData, int32_t ui32MaxCount, uint32_t ui32Offset, ParameterAccessSource tAccessSource, uint8_t ui8AccessLevel)

Enumeration Type Documentation

◆ ACCESS_LEVEL

enum ACCESS_LEVEL

List of access-levels for parameters. Every parameter can limit read and write access according to these levels. (see Access restrictions).

Enumerator
ACCESS_NONE
ACCESS_VIEWER
ACCESS_USER
ACCESS_PROFESSIONAL
ACCESS_DEVELOPER
ACCESS_PLC
ACCESS_SPECIAL1
ACCESS_SPECIAL2
ACCESS_SPECIAL3

◆ FLAGS

enum FLAGS

List of Flags, which can be set for every single parameter First 8 Bits cannot be used, they are occupied by Storage Location and Datatype.

Enumerator
FLAG_NONE	No special flags.
FLAG_SYSTEM	Parameter is added to Parametereditor and only necessary for parametereditor to work properly.
FLAG_HIDDEN	Parameter is not shown by default. Can be activated with option in Parametereditor.
FLAG_SCOPEABLE	Parameter can be scoped.
FLAG_VOLATILE	Value is modified by uC, must be polled regularly.
FLAG_NO_FILE_OVERWRITE	Value is not written on write from Parameterfile Operation. It can only modified manually by user.
FLAG_WRITE_APPROVE_REQUEST	Need special approve before write enable.
FLAG_SPECIAL_WRITE_ENABLE	The value can only be written in case a special option in the Parameter editor is activated.

◆ GET_VALUES

enum GET_VALUES

List of values, that can be retrived with the GetParaDataAsObject function.

Enumerator
GET_MIN
GET_MAX
GET_DEFAULT

◆ ParameterAccessSource

enum ParameterAccessSource

List of sources for parameter-access. Every parameter can limit access to these sources. (see Access restrictions).

Enumerator
PARA_ACCESS_FROM_CODE
PARA_ACCESS_FROM_GUEST
PARA_ACCESS_FROM_USB
PARA_ACCESS_FROM_ETHERNET
PARA_ACCESS_FROM_HESP
PARA_ACCESS_FROM_CAN

◆ STORE_LOCATION

enum STORE_LOCATION

List of storage locations for parameters.

Every parameter can set one of these flags to store the parameter value in a non volatile memory (see Storage of parameter-values in a non volatile memory). Maximum Value = 15

Enumerator
NOT_STORED
PARA_FLASH
NVRAM
EEPROM
EXT_FLASH
SD_BASE
FACTORY_FLASH
SD
FACTORY_EEPROM

◆ ZUGRIFF

enum ZUGRIFF

List of access restrictions for parameters. Every parameter can limit read and write access according to these levels. (see Access restrictions).

Enumerator
VIEWER_READ
VIEWER_WRITE
USER_READ
USER_WRITE
PROFESSIONAL_READ
PROFESSIONAL_WRITE
DEVELOPER_READ
DEVELOPER_WRITE
PLC_READ
PLC_WRITE
SPECIAL1_READ
SPECIAL1_WRITE
SPECIAL2_READ
SPECIAL2_WRITE
SPECIAL3_READ
SPECIAL3_WRITE

Function Documentation

◆ GetDataTypeSize()

int32_t GetDataTypeSize ( uint8_t Type )

Calculate the Size of a parameter-type.

Parameters

Type	Parameter-Type

Returns: Size in Bytes of the given Parameter-Type

◆ GetGroup()

Group * GetGroup ( uint32_t GroupID )

Get the parameter-Group of the given ID.

The group is searched accourding the given Group-ID.

Parameters

GroupID ID of the searched Group

Returns: found Group or 0 if not existent.

◆ GetGroupCount()

uint32_t GetGroupCount ( void )

Get the number of the existent parameter-groups.

The number of groups must be defined in main progframm in the constant ANZAHL_GRUPPEN

Returns: Number of Groups

◆ GetParaDataAsObject()

void GetParaDataAsObject	(	Parameter *	p,
		uint32_t	pData,
		object *	ob,
		uint8_t	ui8AccessLevel
	)

Get Parameter-data as object type.

Dependant of the parameter pData, the Data of the given parameter is returned into object ob.

GET_MIN: The minimum value of the parameter is returned
GET_MAX: The maximum value of the parameter is returned
GET_DEFAULT: The default value of the parameter is returned
GET_BACKUP: The Backup value of the parameter is returned
Parameters

p Pointer to the Parameter.

pData Type of data. element of enum GET_VALUES

[out] ob Object to be written

ui8AccessLevel Actual AccessLevel (see Access restrictions).

◆ GetParameter()

Parameter * GetParameter ( uint32_t ParaID )

Get the parameter of the given ID.

The Parameter is searched accourding the given Parameter-ID.

Parameters

ParaID ID of the searched Parameter

Returns: found Parameter or 0 if not existent.

◆ GetParameterCount()

uint32_t GetParameterCount ( void )

Get the number of the existent parameters.

The number of parameters must be defined in main progframm in the constant ANZAHL_PARAMETER

Returns: Number of Parameters

◆ GetParaValueAsObject()

void GetParaValueAsObject	(	Parameter *	p,
		uint16_t	SubId,
		object *	ob,
		uint8_t	ui8AccessLevel
	)

Get Parameter-value as object type.

The vlaue of the given parameter is returned into object ob.

Parameters

	p	Pointer to the Parameter.
	SubId	SubId of the parameter
[out]	ob	Object to be written
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

◆ GetStringParameterLength()

uint32_t GetStringParameterLength	(	Parameter *	p,
		uint16_t	subID
	)

Get the length of the string data of the given parameter.

If the parameter is not a string-type, the output value is nonsense!

Parameters

p	actual Parameter.
subID	Sub-ID of the parameter

Returns: Length of the data string.

◆ IsValidForRead()

bool IsValidForRead	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

inline

Check if the actual access-right is sufficient to read the parameter.

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Data to store
ui32MaxCount	Buffer size. If smaller than data size, return false
ui32Offset	Start-offset to read from. If bigger than data-size return false.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Return values

true	Parameter can be read
false	Parameter is not allowed to read

◆ IsValidForSetToDefault()

bool IsValidForSetToDefault	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

inline

Check if the actual access-right is sufficient to set to default the parameter.

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Return values

true	Parameter can be set to default
false	Parameter is not allowed to be set to default

◆ IsValidForWrite()

bool IsValidForWrite	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

inline

Check if the actual access-right is sufficient to write the parameter.

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Data to store
ui32MaxCount	Buffer size. If smaller than data size, return false
ui32Offset	Start-offset to read from. If bigger than data-size return false.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Return values

true	Parameter can be written
false	Parameter is not allowed to be written

◆ ObjToFloat32()

float ObjToFloat32 ( object * ob )

Convertrs a given object to float.

Parameters

ob	Object to be converted

Returns: float-value of the given object.

◆ PARA_ObjectToString()

int32_t PARA_ObjectToString	(	Parameter *	p,
		object *	data,
		char *	dest,
		int32_t	MaxLength
	)

Parse Parameter-data out of an object.

This function is used to print the formatted string out of an object. The object is parsed considering the data-type of the parameter.

Parameters

p	Pointer to the parameter.
data	Object to be processed.
dest	Output buffer
MaxLength	Size of the output buffer

Returns: Data size which is copiet into the output buffer

◆ PARA_ParseString()

int32_t PARA_ParseString	(	Parameter *	p,
		int32_t	SubId,
		char *	input,
		uint8_t	AccessLevel
	)

Parse Parameter-data out of an input string.

This function is used to store the binary parameter-value out of a string-value. The string is parsed considering the data-type of the parameter. Only used in serial parameter-interface.

Parameters

p	Pointer to the parameter.
SubId	SubID to be processed.
input	Input string
AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Data size which is stored into paramter data

◆ PARA_ValAsString()

int32_t PARA_ValAsString	(	Parameter *	p,
		int32_t	SubId,
		char *	dest,
		int32_t	MaxLength,
		uint8_t	AccessLevel
	)

Output the parameter value as formatted string.

The Parameter-data is given as a formatted string considering the datatype of the parameter.

Parameters

p	Pointer to the parameter.
SubId	SubID to be processed.
dest	POutput buffer
MaxLength	Size of the output buffer
AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Data size which is stored into output buffer

◆ ReadFunction_STD_F32()

int32_t ReadFunction_STD_F32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for float (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I16()

int32_t ReadFunction_STD_I16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for signed word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I32()

int32_t ReadFunction_STD_I32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for signed int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I32Q16()

int32_t ReadFunction_STD_I32Q16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Deprecated:: Default read-function for signed int (32-Bit) with 16 Bit fraction datatype. This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I64()

int32_t ReadFunction_STD_I64	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for signed int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_I8()

int32_t ReadFunction_STD_I8	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for signed char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_STR()

int32_t ReadFunction_STD_STR	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for string datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead). This function gives the complete string. First one or two character(s) store the length in 7BitEncodedInt Structure (see https://msdn.microsoft.com/en-us/library/dd946975(v=office.12).aspx)

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U16()

int32_t ReadFunction_STD_U16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for unsigned word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U32()

int32_t ReadFunction_STD_U32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for unsigned int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U64()

int32_t ReadFunction_STD_U64	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for unsigned long int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U8()

int32_t ReadFunction_STD_U8	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for unsigned char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ ReadFunction_STD_U8_BitWise()

int32_t ReadFunction_STD_U8_BitWise	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default read-function for unsigned char datatype as bit-array.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is returned if valid for read (see IsValidForRead).

Parameters

	ptThis	Pointer to the Parameter.
	ui16SubId	SubID to read.
[out]	pData	Outputbuffer to store the parametervalue.
	ui32MaxCount	Buffer size. If smaller than data size, return 0
	ui32Offset	Start-offset to read from. If bigger than data-size return 0
	tAccessSource	Source of access (see Access restrictions).
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the used buffer.

◆ SetToDefaultFunction_STD_Const()

int32_t SetToDefaultFunction_STD_Const	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default SetToDefault-function for not writeable parameters.

This write-function can be used, if the parameter is only readable. No Write Operation is allowed.

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data; 0

◆ SetToDefaultFunction_STD_F32()

int32_t SetToDefaultFunction_STD_F32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for float (32-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I16()

int32_t SetToDefaultFunction_STD_I16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for signed word (16-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I32()

int32_t SetToDefaultFunction_STD_I32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for signed int (32-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I32Q16()

int32_t SetToDefaultFunction_STD_I32Q16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Deprecated:: Default setToDefault-function for signed int (32-Bit) with 16 Bit fraction datatype. Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I64()

int32_t SetToDefaultFunction_STD_I64	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for signed long int (64-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_I8()

int32_t SetToDefaultFunction_STD_I8	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for signed char datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_STR()

int32_t SetToDefaultFunction_STD_STR	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for string datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U16()

int32_t SetToDefaultFunction_STD_U16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for nsigned word (16-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U32()

int32_t SetToDefaultFunction_STD_U32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for unsigned int (32-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U64()

int32_t SetToDefaultFunction_STD_U64	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for unsigned long int (64-Bit) datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U8()

int32_t SetToDefaultFunction_STD_U8	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for unsigned char datatype.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ SetToDefaultFunction_STD_U8_BitWise()

int32_t SetToDefaultFunction_STD_U8_BitWise	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default setToDefault-function for signed char datatype as bit-array.

Set Parameter-Value to the factory value. This default function can be used, if no parameter-specific SetToDefault-function is neccessary. The Parameter-data is resetted if valid for write (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to process.
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ StreamReadParameterData_Value()

int32_t StreamReadParameterData_Value	(	Parameter_InfoHeader *	info,
		uint8_t *	destination,
		int32_t	MaxCount,
		uint32_t	offset,
		ParameterAccessSource	Access,
		uint8_t	AccessLevel
	)

Read Parameter-data into buffer (Variant 1) The Data of the selected parameter is read and stored into a given buffer address.

The buffer must be in device memory. The size of the buffer must be at least MaxCount bytes. The data-size can be limited and an offset (start) can be set. with these parameters it is possible to split the data into several smaller buffer portions to transmit data with an interface with smaller pacjet size than parameter-data size. If access is not permitted, data size 0 is returned. In this variant the Parameter-id and sub-id is given, the parameter is searched in memory with these vaules.

Parameters

info	Parameter_InfoHeader which contains Parameter-id and Sub-id of the processed parameter.
destination	Buffer to store the data.
MaxCount	Buffer size of the output buffer / maximum stpored data size into output buffer.
offset	Start position of the data.
Access	Source of access (see Access restrictions).
AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Data size which is stored into destination buffer

◆ StreamReadParameterData_Value2()

int32_t StreamReadParameterData_Value2	(	Parameter *	p,
		uint16_t	subID,
		unsigned char *	destination,
		int	MaxCount,
		uint32_t	offset,
		ParameterAccessSource	Access,
		unsigned char	AccessLevel
	)

Read Parameter-data into buffer (Variant 2) The Data of the selected parameter is read and stored into a given buffer address.

The buffer must be in device memory. The size of the buffer must be at least MaxCount bytes. The data-size can be limited and an offset (start) can be set. with these parameters it is possible to split the data into several smaller buffer portions to transmit data with an interface with smaller pacjet size than parameter-data size. If access is not permitted, data size 0 is returned. In this variant a pointer to the Parameter is given, the parameter has not to be searched in memory withparameter-id and therefore it is faster than variant 1.

Parameters

p	Pointer to the Parameter.
subID	Sub-ID to be read.
destination	Buffer to store the data.
MaxCount	Buffer size of the output buffer / maximum stored data size into output buffer.
offset	Start position of the data.
Access	Source of access (see Access restrictions).
AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Data size which is stored into destination buffer

◆ StreamWriteParameterData_Value()

int32_t StreamWriteParameterData_Value	(	Parameter_InfoHeader *	info,
		unsigned char *	source,
		uint32_t	offset,
		ParameterAccessSource	Access,
		unsigned char	AccessLevel
	)

◆ StreamWriteParameterData_Value2()

int32_t StreamWriteParameterData_Value2	(	Parameter *	p,
		uint16_t	subID,
		unsigned char *	source,
		uint32_t	offset,
		ParameterAccessSource	Access,
		unsigned char	AccessLevel,
		uint16_t	count
	)

Write Parameter-data from buffer (Variant 2) The Data of the given buffer is written to parameter.

The buffer must be in device memory. The buffer may not contain the complete parameter data, even portions are possible. Due to this, the start offset and the data size can be given with parameters. If access is not permitted, data size 0 is returned. In this variant a pointer to the Parameter is given, the parameter has not to be searched in memory withparameter-id and therefore it is faster than variant 1.

Parameters

p	Pointer to the Parameter.
subID	Sub-ID to be write.
source	Buffer containing the parameter data to be written.
offset	Start position of the data.
Access	Source of access (see Access restrictions).
AccessLevel	Actual AccessLevel (see Access restrictions).
count	Number of SubIDs to process

Returns: Data size which is stored into parameter data

◆ StreamWriteStringParameter()

int32_t StreamWriteStringParameter	(	Parameter *	p,
		uint16_t	StartSubID,
		uint16_t	count,
		unsigned char *	destination,
		uint32_t *	MaxCount,
		ParameterAccessSource	Access,
		unsigned char	AccessLevel
	)

Read String Parameter-data into buffer (Variant 1) The Data of the selected string-parameter is read and stored into a given buffer address.

In this function not only one sub-id is read, but the complete data of all sub-ids. The data of one sub-id is not cut -> the length of the buffer mist be larger of every sub-id length. If the next sub-id datalength is larger, than remaining buffer size, the functions returns. It is mainly used by an ethernet-interface, bacause one ethernet-frame can be store normally much more data that one sub-id and therefore it is more efficient to process all sub-ids at once. The buffer must be in device memory. The size of the buffer must be at least MaxCount bytes. The data-size can be limited and an offset (start) can be set. with these parameters it is possible to split the data into several smaller buffer portions to transmit data with an interface with smaller packet size than parameter-data size. If access is not permitted, data size 0 is returned.

Parameters

p	Pointer to the Parameter.
StartSubID	Sub-ID to start the data read.
count	Number of sub-ids to process.
destination	Buffer to store the data.
MaxCount	Pointer to the Buffer size of the output buffer / maximum stpored data size into output buffer. After processing this function the pointer haleds the data size of the destination-buffer which is used.
Access	Source of access (see Access restrictions).
AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Number of sub-ids which were copied.

◆ StreamWriteStringParameter2()

int32_t StreamWriteStringParameter2	(	Parameter *	p,
		uint16_t	StartSubID,
		uint16_t	count,
		unsigned char *	destination,
		uint32_t *	MaxSize,
		ParameterAccessSource	Access,
		unsigned char	AccessLevel,
		unsigned int *	StrPos
	)

Read String Parameter-data into buffer (Variant 2) The Data of the selected string-parameter is read and stored into a given buffer address.

In this function not only one sub-id is read, but the complete data of all sub-ids. The data of one sub-id is cut, if the buffer-size is not large enough to held the complete data of the actual sub-id, the matching part is copied to the buffer. The string position is returned in the parameter StrPos. This Variant should be used, if strings are large, even larger than buffer size. It is mainly used by an ethernet-interface, bacause one ethernet-frame can be store normally much more data that one sub-id and therefore it is more efficient to process all sub-ids at once. The buffer must be in device memory. The size of the buffer must be at least MaxCount bytes. The data-size can be limited and an offset (start) can be set. with these parameters it is possible to split the data into several smaller buffer portions to transmit data with an interface with smaller packet size than parameter-data size. If access is not permitted, data size 0 is returned.

Parameters

p	Pointer to the Parameter.
StartSubID	Sub-ID to start the data read.
count	Number of sub-ids to process.
destination	Buffer to store the data.
MaxSize	Pointer to the Buffer size of the output buffer / maximum stpored data size into output buffer. After processing this function the pointer haleds the data size of the destination-buffer which is used.
Access	Source of access (see Access restrictions).
AccessLevel	Actual AccessLevel (see Access restrictions).
StrPos	Position of the last Sub-ID which does not match completely into buffer.

Returns: Number of sub-ids which were copied.

◆ WriteFunction_STD_Const()

int32_t WriteFunction_STD_Const	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for not writeable parameters.

This write-function can be used, if the parameter is only readable. No Write Operation is allowed.

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: 0

◆ WriteFunction_STD_F32()

int32_t WriteFunction_STD_F32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for float (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I16()

int32_t WriteFunction_STD_I16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for signed word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I32()

int32_t WriteFunction_STD_I32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for signed int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I32Q16()

int32_t WriteFunction_STD_I32Q16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Deprecated:: Default write-function for signed int (32-Bit) with 16 Bit fraction datatype. This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I64()

int32_t WriteFunction_STD_I64	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for signed long int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_I8()

int32_t WriteFunction_STD_I8	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for signed char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_STR()

int32_t WriteFunction_STD_STR	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for string datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead). This function expects the complete string. First one or two character(s) store the length in 7BitEncodedInt Structure (see https://msdn.microsoft.com/en-us/library/dd946975(v=office.12).aspx)

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U16()

int32_t WriteFunction_STD_U16	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for unsigned word (16-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U32()

int32_t WriteFunction_STD_U32	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for unsigned int (32-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U64()

int32_t WriteFunction_STD_U64	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for unsigned long int (64-Bit) datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U8()

int32_t WriteFunction_STD_U8	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for unsigned char datatype.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

◆ WriteFunction_STD_U8_BitWise()

int32_t WriteFunction_STD_U8_BitWise	(	Parameter *	ptThis,
		uint16_t	ui16SubId,
		void *	pData,
		int32_t	ui32MaxCount,
		uint32_t	ui32Offset,
		ParameterAccessSource	tAccessSource,
		uint8_t	ui8AccessLevel
	)

Default write-function for unsigned char datatype as bit-array.

This default function can be used, if no parameter-specific read-function is neccessary. The Parameter-data is written if valid for read (see IsValidForRead).

Parameters

ptThis	Pointer to the Parameter.
ui16SubId	SubID to read.
pData	Inputbuffer to read the parametervalue.
ui32MaxCount	Buffer size. If smaller than data size, return 0
ui32Offset	Start-offset to read from. If bigger than data-size return 0
tAccessSource	Source of access (see Access restrictions).
ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Returns: Size in bytes of the written data

Variable Documentation

◆ ANZAHL_GRUPPEN

const int32_t ANZAHL_GRUPPEN

extern

Number of existent parameter-groups. Must be defined in main program.

◆ ANZAHL_PARAMETER

int32_t ANZAHL_PARAMETER

extern

Number of existent parameters. Must be defined in main program.

◆ g_pui8ActualAccessLevelPointer

uint8_t* g_pui8ActualAccessLevelPointer

extern

Pointer to the Actual access-level (see Access restrictions).

◆ g_ui16FlashModified

uint16_t g_ui16FlashModified

extern

Flag to show if the remanent storage is modified.

On each modification of the stored value, this flag is set. It is displayed in parameter-editor on PC. The flag is resetted on a "save to NV" operation.

◆ g_ui8ActualAccessLevel

uint8_t g_ui8ActualAccessLevel

extern

Actual access-level (see Access restrictions).

◆ GruppenListe

const Group* GruppenListe[]

extern

List of all existent parameter-groups in device. The list is filled by the paraInit function.

◆ ParaListe

Parameter* ParaListe

extern

List of all existent parameters in device. The list is filled by the linker automatically.

	p	Pointer to the Parameter.
	pData	Type of data. element of enum GET_VALUES
[out]	ob	Object to be written
	ui8AccessLevel	Actual AccessLevel (see Access restrictions).

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DEFINE_VAL

◆ ERROR

◆ GetDataType

◆ GetStorageLocation

◆ PARA

◆ Parameter

◆ ParameterF32

◆ ParameterI16

◆ ParameterI32

◆ ParameterI8

◆ ParameterSetToDefaultF32

◆ ParameterSetToDefaultI16

◆ ParameterSetToDefaultI32

◆ ParameterSetToDefaultI8

◆ ParameterSetToDefaultU16

◆ ParameterSetToDefaultU32

◆ ParameterSetToDefaultU8

◆ ParameterSTR

◆ ParameterU16

◆ ParameterU32

◆ ParameterU8

◆ ParameterWriteF32

◆ ParameterWriteI16

◆ ParameterWriteI32

◆ ParameterWriteI8

◆ ParameterWriteU16

◆ ParameterWriteU32

◆ ParameterWriteU8

◆ static_assert

Typedef Documentation

◆ ReadFunction

◆ RestoreDefaultFunction

◆ WriteFunction

Enumeration Type Documentation

◆ ACCESS_LEVEL

◆ FLAGS

◆ GET_VALUES

◆ ParameterAccessSource

◆ STORE_LOCATION

◆ ZUGRIFF

Function Documentation

◆ GetDataTypeSize()

◆ GetGroup()

◆ GetGroupCount()

◆ GetParaDataAsObject()

◆ GetParameter()

◆ GetParameterCount()

◆ GetParaValueAsObject()

◆ GetStringParameterLength()

◆ IsValidForRead()

◆ IsValidForSetToDefault()

◆ IsValidForWrite()

◆ ObjToFloat32()

◆ PARA_ObjectToString()

◆ PARA_ParseString()

◆ PARA_ValAsString()

◆ ReadFunction_STD_F32()

◆ ReadFunction_STD_I16()

◆ ReadFunction_STD_I32()

◆ ReadFunction_STD_I32Q16()

◆ ReadFunction_STD_I64()

◆ ReadFunction_STD_I8()

◆ ReadFunction_STD_STR()

◆ ReadFunction_STD_U16()

◆ ReadFunction_STD_U32()

◆ ReadFunction_STD_U64()

◆ ReadFunction_STD_U8()

◆ ReadFunction_STD_U8_BitWise()

◆ SetToDefaultFunction_STD_Const()

◆ SetToDefaultFunction_STD_F32()

◆ SetToDefaultFunction_STD_I16()

◆ SetToDefaultFunction_STD_I32()