Nothing.

Configures and initializes the UART module.

The internal UART module module is set to:

• receiver enabled
• transmitter enabled
• frame size 8 bits
• 1 STOP bit
• parity mode disabled
• asynchronous operation

Parameters :

• baud_rate: requested baud rate

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

You'll need PIC MCU with hardware UART.

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

  Note : Calculation of the UART baud rate value is carried out by the compiler, as it would produce a relatively large code if performed on the libary level.
Therefore, compiler needs to know the value of the parameter in the compile time. That is why this parameter needs to be a constant, and not a variable.

This will initialize hardware UART1 module and establish the communication at 2400 bps:

  UART1_Init(2400);

Function returns 1 if data is ready or 0 if there is no data.

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

MCU with the UART module.

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

var receive: byte;
...
// read data if ready
if (UART1_Data_Ready() = 1) then
  receive := UART1_Read();

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

// If the previous data has been shifted out, send next data:
if (UART1_Tx_Idle() <> 0)
begin 
  ...
end;

Received byte.

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

MCU with the UART module.

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

var receive: byte;
...
// read data if ready
if (UART1_Data_Ready() = 1) then
  receive := UART1_Read();

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

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

 while TRUE do
   begin
     if (UART1_Data_Ready() = 1) then           // if data is received 
       begin  
         UART1_Read_Text(output, 'OK', 10); // reads text until 'OK' is found
         UART1_Write_Text(output);             // sends back text 
       end;
   end;

Nothing.

The function transmits a byte via the UART module.

Parameters :

• TxData: data to be sent

MCU with the UART module.

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

var data_: byte;
...
data := 0x1E
UART1_Write(data_);

Nothing.

Sends text (parameter uart_text) via UART. Text should be zero terminated.

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:

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

 while TRUE do
   begin
     if (UART1_Data_Ready() = 1) then           // if data is received 
       begin  
         UART1_Read_Text(output, 'OK', 10); // reads text until 'OK' is found
         UART1_Write_Text(output);             // sends back text 
       end;
   end;

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

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

Function returns 1 if data is ready or 0 if there is no data.

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.

MCU with the UART module.

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

var receive: byte;
...
// read data if ready
if (UART_Data_Ready() = 1) then
  receive := UART_Read();

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

// If the previous data has been shifted out, send next data:
if (UART_Tx_Idle() <> 0)
begin 
  ...
end;

Received byte.

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.

MCU with the UART module.

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

var receive: byte;
...
// read data if ready
if (UART_Data_Ready() = 1) then
  receive := UART_Read();

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

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.

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

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

 while TRUE do
   begin
     if (UART_Data_Ready() = 1) then           // if data is received 
       begin  
         UART_Read_Text(output, 'OK', 10); // reads text until 'OK' is found
         UART_Write_Text(output);             // sends back text 
       end;
   end;

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 :

• TxData: data to be sent

MCU with the UART module.

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

var data_: byte;
...
data := 0x1E
UART_Write(data_);

Nothing.

Sends text (parameter uart_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.

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:

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

 while TRUE do
   begin
     if (UART_Data_Ready() = 1) then           // if data is received 
       begin  
         UART_Read_Text(output, 'OK', 10); // reads text until 'OK' is found
         UART_Write_Text(output);             // sends back text 
       end;
   end;