aUEI.h

group aUEI

UEI Utilities.

aUEI.h Provides structs and utilities for working with UEIs.

enum dataType

Typedef Enum dataType.

UEI datatype

Values:

aUEI_VOID = 0

Void datatype.

aUEI_BYTE = 1

Char datatype.

aUEI_SHORT = 2

Short datatype.

aUEI_INT = 4

Int datatype.

struct uei

Typedef Struct uei.

UEI data struct.

Public Members

uint8_t module

Module address.

uint8_t command

Command code.

uint8_t option

option code & UEI operation.

uint8_t specifier

Entity index & response specifier.

uint8_t byteVal

Char value union member.

uint16_t shortVal

Short value union member.

uint32_t intVal

Int value union member.

dataType type

Union dataType.

uint16_t aUEI_RetrieveShort(const uint8_t *p)

Retreive a short from a UEI.

Return
uint16_t The short value.
Parameters
  • p: Pointer to byte array containing short.

void aUEI_StoreShort(uint8_t *p, uint16_t v)

Store a short in a UEI.

Parameters
  • p: Pointer to uei shortVal.
  • v: Short value to store.

uint32_t aUEI_RetrieveInt(const uint8_t *p)

Retreive an Int from a UEI.

Return
uint32_t The integer value.
Parameters
  • p: Pointer to byte array containing the Int.

void aUEI_StoreInt(uint8_t *p, uint32_t v)

Store an Int in a UEI.

Parameters
  • p: Pointer to the IntVal of a UEI.
  • v: The value to store.