epucklib/html/a00028_source.html

 /*


 embedded system library for e-puck


 --------------------------------------------------------------------------------


 code distribution:

 https://github.com/jianingchen/epucklib


 online documentation:

 http://jianingchen.github.io/epucklib/html/


 --------------------------------------------------------------------------------


 This file is released under the terms of the MIT license (see "el.h").


 */


 #ifndef EL_UART_H

 #define EL_UART_H


 #include "el_common.h"


 #define EL_UART_1       0

 #define EL_UART_2       1

 #define EL_UART_BLUETOOTH   EL_UART_1


 void el_uart_use_reset_code(el_bool k,el_int8 x);


 void el_uart_send_char(el_index ch,char c);


 void el_uart_send_string(el_index ch,const char*str);


 bool el_uart_is_sending(el_index ch);


 el_uint16 el_uart_get_char_counter(el_index ch);


 char el_uart_get_char(el_index ch);


 void el_uart_flush_char(el_index ch);


 el_uint16 el_uart_get_string(el_index ch,char*buf,el_uint16 buf_size,el_bool return_line);


 char el_uart_peek_first_char(el_index ch);


 char el_uart_peek_last_char(el_index ch);


 void el_uart_erase_last_char(el_index ch);


 /*

 --------------------------------------------------------------------------------

 */


 #ifdef EL_INCLUDE_LIB_INTERNAL_CONTEXT


 #define EL_UART_NEWLINE_CRLF


 #define EL_UART_BAUDRATE    115200

 #define EL_UART_TX_BUF_DIM  80

 #define EL_UART_RX_BUF_DIM  64


 extern volatile el_bool el_uart_reset_code_enable;

 extern el_uint8 el_uart_reset_code;

 extern el_uint16 el_uart1_tx_counter;

 extern char*el_uart1_tx_pointer;

 extern char el_uart1_tx_buffer[EL_UART_TX_BUF_DIM];

 extern volatile el_uint8 el_uart1_rx_buf_i;

 extern volatile el_uint8 el_uart1_rx_buf_o;

 extern char el_uart1_rx_buffer[EL_UART_RX_BUF_DIM];


 void el_init_uart();

 void el_uart1_tx_clear();

 void el_uart1_tx_issue();

 void el_uart2_tx_clear();

 void el_uart2_tx_issue();


 #endif


 #endif  /* EL_UART_H */

el_uart_send_char
void el_uart_send_char(el_index ch, char c)
Send one byte of data to the serial channel.

el_uart_get_string
el_uint16 el_uart_get_string(el_index ch, char *buf, el_uint16 buf_size, el_bool return_line)
Get a string ended with a null (0 or '\0') or a carriage-return ('\r', (the "Enter" key)...

el_uart_use_reset_code
void el_uart_use_reset_code(el_bool k, el_int8 x)
Setup a value that: upon receiving that value, reset the chip.

el_uart_send_string
void el_uart_send_string(el_index ch, const char *str)
Send a string (an array of char terminated by a null) to the serial channel.

el_uart_get_char_counter
el_uint16 el_uart_get_char_counter(el_index ch)
Check how many bytes are received and buffered in the channel.

el_uart_peek_first_char
char el_uart_peek_first_char(el_index ch)
Check the first byte in the receiving buffer, but does not remove it from the buffer.

el_uart_peek_last_char
char el_uart_peek_last_char(el_index ch)
Check the last byte in the receiving buffer but do not remove it from the buffer. ...

el_uart_flush_char
void el_uart_flush_char(el_index ch)
Totally clear up the receiving buffer of a serial channel.

el_uart_get_char
char el_uart_get_char(el_index ch)
Take out one byte from the receiving buffer in order of first-in-first-out.

el_uart_erase_last_char
void el_uart_erase_last_char(el_index ch)
Remove the last byte received in the receiving buffer.

el_common.h

el_uart_is_sending
bool el_uart_is_sending(el_index ch)
Check whether the transmission issued in the last sending function is finished.