Nothing.

Initializes hardware UART Remappable 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.

Parameters :

• baud_rate: requested baud rate

  Note : Before using this library, make sure that Peripheral Pin Select Library is checked in the Library Manager, and that appropriate pins were mapped.

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

You'll need PIC MCU with hardware UART module and remappable feature.

UART_Remappable_Init needs to be called before using other functions from UART Remappable 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 UART module and establish the communication at 2400 bps:

UART_Remappable_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 and remappable feature.

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

dim receives as byte
...
' read data if ready
if (UART_Remappable_Data_Ready() = 1) then
  receive = UART_Remappable_Read()
end if

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

' If the previous data has been shifted out, send next data:
if (UART_Remappable_Tx_Idle() = 1) then
  UART1_Write(_data)
end if

Received byte.

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

MCU with the UART module and remappable feature.

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

dim receive as byte
...
' read data if ready
if (UART_Remappable_Data_Ready() = 1) then
  receive = UART_Remappable_Read()
end if

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

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

UART_Remappable_Init(4800)                            ' initialize UART module
Delay_ms(100)

while TRUE 
  if (UART_Remappable_Data_Ready() = 1) then          ' if data is received 
    UART_Remappable_Read_Text(output, 'OK', 10)       ' reads text until 'OK' is found
    UART_Remappable_Write_Text(output)                ' sends back text 
  end if
wend

Nothing.

The function transmits a byte via the UART module.

Parameters :

• TxData: data to be sent

MCU with the UART module and remappable feature.

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

dim data_ as byte
...
data = 0x1E
UART_Remappable_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 UART_Remappable_Init.

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

UART_Remappable_Init(4800)                         ' initialize UART module
Delay_ms(100)

while TRUE
  if (UART_Remappable_Data_Ready() = 1) then       ' if data is received 
    UART_Remappable_Read_Text(output, 'OK', 10)    ' reads text until 'OK' is found
    UART_Remappable_Write_Text(output)             ' sends back text 
  end if
wend