From bbf146166834b91cf72d36d81b9d5d1145dbc6f2 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Thu, 27 Jan 2022 15:51:46 +0000 Subject: deploy: 14e4562b7a44ab6882180b69145665d4920769ac --- group__uart.html | 249 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 249 insertions(+) create mode 100644 group__uart.html (limited to 'group__uart.html') diff --git a/group__uart.html b/group__uart.html new file mode 100644 index 00000000..d0c23375 --- /dev/null +++ b/group__uart.html @@ -0,0 +1,249 @@ + + + + + + + +Sensor Watch: UART + + + + + + + + + +
+
+ + + + + + +
+
Sensor Watch +  0.0.0 +
+
A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+Functions
+
+
UART
+
+
+ +

This section covers functions related to the UART peripheral. +More...

+ + + + + + + + + + + + + + + + + +

+Functions

void watch_enable_uart (const uint8_t tx_pin, const uint8_t rx_pin, uint32_t baud)
 Initializes the debug UART. More...
 
void watch_uart_puts (char *s)
 Transmits a string of bytes on the UART's TX pin. More...
 
char watch_uart_getc (void)
 Receives a single byte from the UART's RX pin. More...
 
 __attribute__ ((deprecated("Use watch_enable_uart to enable the UART."))) void watch_enable_debug_uart(uint32_t baud)
 Initializes the debug UART. More...
 
 __attribute__ ((deprecated("Use watch_uart_puts to print to the UART, or printf to log debug messages over USB."))) void watch_debug_putc(char c)
 Outputs a single character on the debug UART. More...
 
+

Detailed Description

+

This section covers functions related to the UART peripheral.

+

Function Documentation

+ +

◆ __attribute__() [1/2]

+ +
+
+ + + + + + + + +
__attribute__ ((deprecated("Use watch_enable_uart to enable the UART.")) )
+
+ +

Initializes the debug UART.

+
Parameters
+ + +
baudThe baud rate
+
+
+ +
+
+ +

◆ __attribute__() [2/2]

+ +
+
+ + + + + + + + +
__attribute__ ((deprecated("Use watch_uart_puts to print to the UART, or printf to log debug messages over USB.")) )
+
+ +

Outputs a single character on the debug UART.

+

Outputs a string on the debug UART.

+
Parameters
+ + + +
cThe character you wish to output.
sA null-terminated string.
+
+
+ +
+
+ +

◆ watch_enable_uart()

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
void watch_enable_uart (const uint8_t tx_pin,
const uint8_t rx_pin,
uint32_t baud 
)
+
+ +

Initializes the debug UART.

+
Parameters
+ + + + +
tx_pinThe pin the watch will use to transmit, or 0 for a receive-only UART. If specified, must be either A2 or A4.
rx_pinThe pin the watch will use to receive, or 0 for a transmit-only UART. If specified, must be A1, A2, A3 or A4 (pin A0 cannot receive UART data).
baudThe baud rate for the UART. A typical value is 19200.
+
+
+ +
+
+ +

◆ watch_uart_getc()

+ +
+
+ + + + + + + + +
char watch_uart_getc (void )
+
+ +

Receives a single byte from the UART's RX pin.

+
Returns
the received byte.
+
Note
This method will block until a byte is received!
+ +
+
+ +

◆ watch_uart_puts()

+ +
+
+ + + + + + + + +
void watch_uart_puts (char * s)
+
+ +

Transmits a string of bytes on the UART's TX pin.

+
Parameters
+ + +
sA null-terminated string containing the bytes you wish to transmit.
+
+
+ +
+
+
+ +
+Generated by doxygen 1.9.1 +
+ + -- cgit v1.2.3