UART Class

class UARTClass : public Acroname::BrainStem::EntityClass

UARTClass. A UART is a “Universal Asynchronous Receiver/Transmitter. Many times referred to as a COM (communication), Serial, or TTY (teletypewriter) port.

The UART Class allows the enabling and disabling of the UART data lines.

Public Functions

UARTClass(void)

Constructor.

~UARTClass(void)

Destructor.

void init(Module *pModule, const uint8_t index)

Initialize the class.

Parameters
  • pModule: The module to which this entity belongs.
  • index: The index of the entity, i.e. aMUX_UART or aMUX_USB.

aErr setEnable(const uint8_t bEnable)

Enable the UART channel.

Return
Returns common entity return values
Parameters
  • bEnable: False or 0 = Disabled, True or 1 = Enabled

aErr getEnable(uint8_t *bEnabled)

Get the UART channel state.

Return
Returns common entity return values
Parameters
  • bEnabled: true: enabled, false: disabled.