Configures and initializes the UART module.

The internal UART module module is set to :

• default Tx and Rx pins.
• 8-bit data, no parity.
• 1 STOP bit.

• baud_rate: requested baud rate.

Nothing.

Routine requires the UART module.

// Initialize hardware UART1 module and establish communication at 2400 bps
UART1_Init(2400);

• Refer to the device data sheet for baud rates allowed for specific peripheral clock values.
• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Switching between the UART modules in the UART library is done by the UART_Set_Active function (UART modules have to be previously initialized).
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.
• UART modules are set on the following pins :

  Stellaris

  • UART0 :
    • PA0/PA1 (all Cortex M3 and M4 MCUs).
  • UART1 :
    • PB0/PB1 - all Cortex M4 MCUs and following Cortex M3 MCUs : LM3S1607, LM3S1627, LM3S3634, LM3S3739, LM3S3749, LM3S5632, LM3S5732 and LM3S5739.
    • PB4/PB5 - LM3S1626.
    • PC6/PC7 - LM3S3748.
    • PD2/PD3 - all other Cortex M3 MCUs not listed before.
  • UART2 :
    • PB4/E4 - LM3S1607 Cortex M3.
    • PD0/PD1 - LM3S3739, LM3S3749 and LM3S5739 Cortex M3.
    • PG0/PG1 - all other Cortex M3 MCUs not listed before.
    • PD4/PD5 - TM4C129x Cortex M4 family.
    • PD6/PD7 - TM4C123x Cortex M4 family.
  • UART3 :
    • PJ0/PJ1 - TM4C129x Cortex M4 family.
    • PC6/PC7 - TM4C123x Cortex M4 family.
  • UART4 :
    • PA2/PA3 - TM4C129x Cortex M4 family.
    • PC4/PC5 - TM4C123x Cortex M4 family.
  • UART5 :
    • PH6/PH7 - TM4C129x Cortex M4 family.
    • PE4/PE5 - TM4C123x Cortex M4 family.
  • UART6 :
    • PP0/PP1 - TM4C129x Cortex M4 family.
    • PD4/PD5 - TM4C123x Cortex M4 family.
  • UART7 :
    • PC4/PC5 - TM4C129x Cortex M4 family.
    • PE0/PE1 - TM4C123x Cortex M4 family.
  • The compiler will choose for which speed the calculation is to be performed (high or low). This does not mean that it is the best choice for desired baud rate.
    If the baud rate error generated in this way is too big then UARTx_Init_Advanced routine, which allows speed select, should be used.

  MSP432

  • UART0 :
    • PA2/PA3.
  • UART1 :
    • PA10/PA11.
  • UART2 :
    • PB2/PB3.
  • UART3 :
    • PE6/PE7.

  STM32

  • UART1 :
    • PA9/PA10 - all Cortex M0, M3 and M4 MCUs.
  • UART2 :
    • PA2/PA3 - all Cortex M0, M3 and M4 MCUs.
  • UART3 :
    • PB8/PB9 - STM32F373x/STM32F378x/STM32F383x Cortex M4 MCUs.
    • PC6/PC7 - STM32F401/411 Cortex M4 MCUs.
    • PB10/PB11 all Cortex M0, M3 and other Cortex M4 MCUs not listed before.
  • UART4 :
    • PA0/PA1 - all Cortex M0 MCUs.
    • PC10/PC11 - all Cortex M3 and Cortex M4 MCUs.
  • UART5 :
    • PC12/PD2 - all Cortex M3 and Cortex M4 MCUs.
  • UART6 :
    • PC6/PC7 - all Cortex M3 and Cortex M4 MCUs.
  • UART7 :
    • PE7/PE8 - all Cortex M4 MCUs.
  • UART8 :
    • PE0/PE1 - all Cortex M4 MCUs.

  CEC1302

  • UART1 :
    • GPIO162/GPIO165

  CEC1702

  • UART0 :
    • GPIO104/GPIO105

  • UART1 :
    • GPIO171/GPIO170

  Kinetis

  • UART0 :
    • PB16/PB17
  • UART1 :
    • PC4/PC3
  • UART2 :
    • PD3/PD2
  • UART3 :
    • PC16/PC17
  • UART4 :
    • PE24/PE25
  • UART5 :
    • PD9/PD8

Configures and initializes the UART module with user defined settings.

Nothing.

Routine requires the UART module.

• Refer to the device data sheet for baud rates allowed for specific peripheral clock values.
• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Switching between the UART modules in the UART library is done by the UART_Set_Active function (UART modules have to be previously initialized).
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.
• For available working modes for a specific MCU please read the appropriate datasheet.

The function tests if data in receive buffer is ready for reading.

None.

• 1 if data is ready for reading.
• 0 if there is no data in the receive register.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

unsigned receive;
...
// read data if ready
if (UART1_Data_Ready())
  receive = UART1_Read();

• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Use the function to test if the transmit shift register is empty or not.

None.

• 1 if the data has been transmitted.
• 0 otherwise.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

// If the previous data has been shifted out, send next data:
if (UART1_Tx_Idle() == 1) {
  UART1_Write(_data);
 }

• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

The function receives a byte via UART. Use the UARTx_Data_Ready function to test if data is ready first.

None.

Received byte.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

unsigned receive;
...
// read data if ready
if (UART1_Data_Ready())
  receive = UART1_Read();

• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Reads characters received via UART until the delimiter sequence is detected. The read sequence is stored in the parameter output; delimiter sequence is stored in the parameter delimiter.

This is a blocking call: the delimiter sequence is expected, otherwise the procedure exits (if the delimiter is not found).

• Output: received text.
• Delimiter: sequence of characters that identifies the end of a received string.
• Attempts: defines number of received characters in which Delimiter sequence is expected. If Attempts is set to 255, this routine will continuously try to detect the Delimiter sequence.

Nothing.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

Read text until the sequence “OK” is received, and send back what’s been received:

UART1_Init(4800);                         // initialize UART1 module
Delay_ms(100);

while (1) {
  if (UART1_Data_Ready() == 1) {          // if data is received 
    UART1_Read_Text(output, "OK", 10);    // reads text until 'OK' is found
    UART1_Write_Text(output);             // sends back text 
 }
}

• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

The function transmits a byte via the UART module.

• _data: data to be sent.

Nothing.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

unsigned data = 0x1E;
...
UART1_Write(data);

• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Sends text via UART. Text should be zero terminated and is limited to 255 characters.

• UART_text: text to be sent.

Nothing.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

Read text until the sequence “OK” is received, and send back what’s been received:

UART1_Init(4800);                         // initialize UART1 module
Delay_ms(100);

while (1) {
  if (UART1_Data_Ready() == 1) {          // if data is received 
    UART1_Read_Text(output, "OK", 10);    // reads text until 'OK' is found
    UART1_Write_Text(output);             // sends back text 
 }
}

• UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.
• Number of UART modules per MCU differs from chip to chip. Please, read the appropriate datasheet before utilizing this library.

Sets active UART module which will be used by UARTx_Data_Ready, UARTx_Read and UARTx_Write routines.

Parameters :

• read_ptr: UARTx_Read handler.
• write_ptr: UARTx_Write handler.
• ready_ptr: UARTx_Data_Ready handler.
• tx_idle_ptr: UARTx_Tx_Idle handler.

Nothing.

Routine is available only for MCUs with multiple UART modules.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

UART1_Init(9600);                    // initialize UART1 module
UART2_Init(9600);                    // initialize UART2 module

RS485Master_Init();                  // initialize MCU as Master

UART_Set_Active(&UART1_Read, &UART1_Write, &UART1_Data_Ready, &UART1_Tx_Idle); // set UART1 active
RS485Master_Send(dat,1,160);        // send message through UART1

UART_Set_Active(&UART2_Read, &UART2_Write, &UART2_Data_Ready, &UART2_Tx_Idle); // set UART2 active
RS485Master_Send(dat,1,160);        // send through UART2

None.

This function enables desired UART module.

• UART_Base: desired UART module base address.

Nothing.

UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.

// Enable UART1 module
UART1_Enable(&USART1_SR);

Routine is available only for ST MCUs.

This function disables desired UART module.

• UART_Base: desired UART module base address.

Nothing.

UART library routines require you to specify the module you want to use. To select the desired UART module, simply change the letter x in the routine prototype for a number from 0 to 7.

// Disable UART1 module
UART1_Enable(&USART1_SR);

Routine is available only for ST MCUs.

The function tests if data in receive buffer is ready for reading.

This is a generic routine which uses the active UART module previously activated by the UART_Set_Active routine.

None.

• 1 if data is ready for reading.
• 0 if there is no data in the receive register.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

unsigned receive;
...
// read data if ready
if (UART_Data_Ready())
  receive = UART_Read();

None.

Use the function to test if the transmit shift register is empty or not.

This is a generic routine which uses the active UART module previously activated by the UART_Set_Active routine.

None.

• 1 if the data has been transmitted.
• 0 otherwise.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

// If the previous data has been shifted out, send next data:
if (UART_Tx_Idle() == 1) {
  UART_Write(_data);
 }

None.

The function receives a byte via UART. Use the UART_Data_Ready function to test if data is ready first.

This is a generic routine which uses the active UART module previously activated by the UART_Set_Active routine.

None.

Received byte.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

unsigned receive;
...
// read data if ready
if (UART_Data_Ready())
  receive = UART_Read();

None.

Reads characters received via UART until the delimiter sequence is detected. The read sequence is stored in the parameter output; delimiter sequence is stored in the parameter delimiter.

This is a blocking call: the delimiter sequence is expected, otherwise the procedure exits (if the delimiter is not found).

This is a generic routine which uses the active UART module previously activated by the UART_Set_Active routine.

• Output: received text.
• Delimiter: sequence of characters that identifies the end of a received string.
• Attempts: defines number of received characters in which Delimiter sequence is expected. If Attempts is set to 255, this routine will continuously try to detect the Delimiter sequence.

Nothing.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

Read text until the sequence “OK” is received, and send back what’s been received:

while (1) {
  if (UART_Data_Ready() == 1) {          // if data is received 
    UART_Read_Text(output, "OK", 10);    // reads text until 'OK' is found
    UART_Write_Text(output);             // sends back text 
 }
}

None.

The function transmits a byte via the UART module.

This is a generic routine which uses the active UART module previously activated by the UART_Set_Active routine.

• _data: data to be sent.

Nothing.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

unsigned data = 0x1E;
...
UART_Write(data);

None.

Sends text via UART. Text should be zero terminated and is limited to 255 characters.

This is a generic routine which uses the active UART module previously activated by the UART_Set_Active routine.

• UART_text: text to be sent.

Nothing.

Routine requires at least one UART module.

Used UART module must be initialized before using this routine. See UARTx_Init and UARTx_Init_Advanced routines.

Read text until the sequence “OK” is received, and send back what’s been received:

while (1) {
  if (UART_Data_Ready() == 1) {          // if data is received 
    UART_Read_Text(output, "OK", 10);    // reads text until 'OK' is found
    UART_Write_Text(output);             // sends back text 
 }
}

None.