void UARTx_Init(constunsigned long baud_rate);

Nothing.

Initializes desired hardware UART module with the desired baud rate. Refer to the device data sheet for baud rates allowed for specific Fosc. If you specify the unsupported baud rate, compiler will report an error.

You need PIC MCU with hardware UART.

UARTx_Init needs to be called before using other functions from UART Library.

Parameters :

• baud_rate: requested baud rate

Refer to the device data sheet for baud rates allowed for specific Fosc.

char UARTx_Data_Ready();

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

Use the function to test if data in receive buffer is ready for reading.

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

char UARTx_Tx_Idle();

• 1 if the data has been transmitted
• 0 otherwise

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

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

char UARTx_Read();

Returns the received byte.

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

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

void UARTx_Read_Text(char *Output, char *Delimiter, char Attempts);

Nothing.

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).

Parameters :

• 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.

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

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

void UARTx_Write(char data_);

Nothing.

The function transmits a byte via the UART module.

Parameters :

• _data: data to be sent

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

void UARTx_Write_Text(char * UART_text);

Nothing.

Sends text via UART. Text should be zero terminated.

Parameters :

• UART_text: text to be sent

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

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

void UART_Set_Active(char (*read_ptr)(), void (*write_ptr)(unsigned char data_), char (*ready_ptr)(), char (*tx_idle_ptr)())

Nothing.

Sets active UART module which will be used by the UART library 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

Routine is available only for MCUs with two UART modules.

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

char UART_Data_Ready();

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

Use the function to test 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.

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

char UART_Tx_Idle();

• 1 if the data has been transmitted
• 0 otherwise

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.

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

char UART_Read();

Returns the received byte.

Function receives a byte via UART. Use the function UART_Data_Ready 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.

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

void UART_Read_Text(char *Output, char *Delimiter, char Attempts);

Nothing.

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.

Parameters :

• 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.

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

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

void UART_Write(char data_);

Nothing.

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.

Parameters :

• _data: data to be sent

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

void UART_Write_Text(char * UART_text);

Nothing.

Sends text via UART. Text should be zero terminated.

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

Parameters :

• UART_text: text to be sent

UART HW module must be initialized and communication established before using this function. See UARTx_Init.

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