KETCube Common deffinitions nd inline functions. More...

Macros
#define	TRUE 1
	boolean TRUE More...

#define	FALSE 0
	boolean FALSE More...

#define	KETCUBE_COMMON_BUFFER_LEN 256

Typedefs
typedef uint8_t	byte

Functions
void	KETCube_ErrorHandler (void)

char *	ketCube_common_bytes2Str (uint8_t *byteArr, uint8_t len)

static void	ketCube_common_Byte2hex (uint8_t byte, char *str)
	Convert a single Byte to HEX string (two bytes) More...

static void	ketCube_common_Int2dec (int32_t number, char *str, int len)
	Convert an integer to DEC string (with defined length, counting zero terminator) More...

static bool	ketCube_common_IsHexString (const char *str, uint8_t len)
	Test if the string is valid HEX string. More...

static bool	ketCube_common_IsDecString (const char *str, uint8_t len)
	Test if the string is valid DEC string. More...

static uint8_t	ketCube_common_Hex2Val (const char c)
	Convert HEX char to Int (Byte) More...

static void	ketCube_common_Hex2Bytes (uint8_t bytes, const char str, uint8_t len)
	Convert HEX string to Byte array. More...

static void	ketCube_common_Dec2int (int32_t output, const char str, uint8_t len)
	Convert DEC string to 4 byte signed integer. More...

static uint8_t	ketCube_common_Min (uint8_t a, uint8_t b)
	Return minimum of two bytes. More...

static uint8_t	ketCube_common_Max (uint8_t a, uint8_t b)
	Return maximum of two bytes. More...

static uint16_t	ketCube_common_Med (uint16_t *values, uint16_t size)
	Return median from an array of shorts. More...

static uint32_t	ketCube_common_Med32 (uint32_t *values, uint32_t size)
	Return median from an array of shorts. More...

static uint32_t	ketCube_common_Max32 (uint32_t *values, uint32_t size)
	Return max from an array of ints. More...

static uint32_t	ketCube_common_Min32 (uint32_t *values, uint32_t size)
	Return max from an array of ints. More...

static uint16_t	ketCube_common_Avg (uint16_t *values, uint16_t size)
	Return median from an array of shorts. More...

static uint16_t	ketCube_common_swapW (uint16_t n)
	Swap word (16-bit) values. More...

static void	ketCube_common_BasicErrorHandler ()
	Basic Error Handler. More...

Variables
char	ketCube_common_buffer []

Detailed Description

KETCube Common deffinitions nd inline functions.

This KETCube module incorporates common defs

Macro Definition Documentation

◆ FALSE

#define FALSE 0

boolean FALSE

◆ KETCUBE_COMMON_BUFFER_LEN

#define KETCUBE_COMMON_BUFFER_LEN 256

◆ TRUE

#define TRUE 1

boolean TRUE

Typedef Documentation

◆ byte

typedef uint8_t byte

Function Documentation

◆ ketCube_common_Avg()

static uint16_t ketCube_common_Avg	(	uint16_t *	values,
		uint16_t	size
	)

inlinestatic

Return median from an array of shorts.

Parameters

values	shorts array
size	array size

Return values

avg median

◆ ketCube_common_BasicErrorHandler()

static void ketCube_common_BasicErrorHandler ( )

inlinestatic

Basic Error Handler.

◆ ketCube_common_Byte2hex()

static void ketCube_common_Byte2hex	(	uint8_t	byte,
		char *	str
	)

inlinestatic

Convert a single Byte to HEX string (two bytes)

Parameters

byte	a single byte to convert
str	pointer to a two-byte string

◆ ketCube_common_bytes2Str()

char* ketCube_common_bytes2Str	(	uint8_t *	byteArr,
		uint8_t	len
	)

Print byte array to ketCube_common_buffer

Parameters

byteArr	byte array
len	byte array length

Return values

str	pointer to resulting (NULL-terminated) string

Note: Use this function out of ISR only!

◆ ketCube_common_Dec2int()

static void ketCube_common_Dec2int	(	int32_t *	output,
		const char *	str,
		uint8_t	len
	)

inlinestatic

Convert DEC string to 4 byte signed integer.

Parameters

output	pointer to output integer
str	pointer to HEX string
len	HEX string length

◆ ketCube_common_Hex2Bytes()

static void ketCube_common_Hex2Bytes	(	uint8_t *	bytes,
		const char *	str,
		uint8_t	len
	)

inlinestatic

Convert HEX string to Byte array.

Parameters

bytes	pointer to byte array
str	pointer to HEX string
len	HEX string length

Note: in case of error (range), function exits immediately

◆ ketCube_common_Hex2Val()

static uint8_t ketCube_common_Hex2Val ( const char c )

inlinestatic

Convert HEX char to Int (Byte)

Parameters

c	hex character

Return values

character value 0 - 15; in case of error 0xFF

Note: the function is safe – ranges are checked strictly

◆ ketCube_common_Int2dec()

static void ketCube_common_Int2dec	(	int32_t	number,
		char *	str,
		int	len
	)

inlinestatic

Convert an integer to DEC string (with defined length, counting zero terminator)

Parameters

number	a number to be converted
str	pointer to a string of given length
len	length of given string

◆ ketCube_common_IsDecString()

static bool ketCube_common_IsDecString	(	const char *	str,
		uint8_t	len
	)

inlinestatic

Test if the string is valid DEC string.

Parameters

str	pointer to DEC string
len	DEC string length

Return values

TRUE	if it is a valid DEC string
FALSE	otherwise

◆ ketCube_common_IsHexString()

static bool ketCube_common_IsHexString	(	const char *	str,
		uint8_t	len
	)

inlinestatic

Test if the string is valid HEX string.

Parameters

str	pointer to HEX string
len	HEX string length

Return values

TRUE	if it is a valid HEX string
FALSE	otherwise

◆ ketCube_common_Max()

static uint8_t ketCube_common_Max	(	uint8_t	a,
		uint8_t	b
	)

inlinestatic

Return maximum of two bytes.

Parameters

a	a number
b	a number

Return values

max maximum

◆ ketCube_common_Max32()

static uint32_t ketCube_common_Max32	(	uint32_t *	values,
		uint32_t	size
	)

inlinestatic

Return max from an array of ints.

Parameters

values	shorts array
size	array size

Return values

max maximum

◆ ketCube_common_Med()

static uint16_t ketCube_common_Med	(	uint16_t *	values,
		uint16_t	size
	)

inlinestatic

Return median from an array of shorts.

Parameters

values	shorts array
size	array size

Return values

med median

◆ ketCube_common_Med32()

static uint32_t ketCube_common_Med32	(	uint32_t *	values,
		uint32_t	size
	)

inlinestatic

Return median from an array of shorts.

Parameters

values	shorts array
size	array size

Return values

med median

◆ ketCube_common_Min()

static uint8_t ketCube_common_Min	(	uint8_t	a,
		uint8_t	b
	)

inlinestatic

Return minimum of two bytes.

Parameters

a	a number
b	a number

Return values

min minimum

◆ ketCube_common_Min32()

static uint32_t ketCube_common_Min32	(	uint32_t *	values,
		uint32_t	size
	)

inlinestatic

Return max from an array of ints.

Parameters

values	shorts array
size	array size

Return values

max maximum

◆ ketCube_common_swapW()

static uint16_t ketCube_common_swapW ( uint16_t n )

inlinestatic

Swap word (16-bit) values.

This is intended for conversion when different Endianity is used

Parameters

n	a 16-bit number

Return values

n	with swapped bytes

◆ KETCube_ErrorHandler()

void KETCube_ErrorHandler ( void )

Variable Documentation

◆ ketCube_common_buffer

char ketCube_common_buffer[]

extern

Shared buffer for common usage anywhere.

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FALSE

◆ KETCUBE_COMMON_BUFFER_LEN

◆ TRUE

Typedef Documentation

◆ byte

Function Documentation

◆ ketCube_common_Avg()

◆ ketCube_common_BasicErrorHandler()

◆ ketCube_common_Byte2hex()

◆ ketCube_common_bytes2Str()

◆ ketCube_common_Dec2int()

◆ ketCube_common_Hex2Bytes()

◆ ketCube_common_Hex2Val()

◆ ketCube_common_Int2dec()

◆ ketCube_common_IsDecString()

◆ ketCube_common_IsHexString()

◆ ketCube_common_Max()

◆ ketCube_common_Max32()

◆ ketCube_common_Med()

◆ ketCube_common_Med32()

◆ ketCube_common_Min()

◆ ketCube_common_Min32()

◆ ketCube_common_swapW()

◆ KETCube_ErrorHandler()

Variable Documentation

◆ ketCube_common_buffer