diff options
| author | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2010-12-26 14:25:34 +0000 |
|---|---|---|
| committer | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2010-12-26 14:25:34 +0000 |
| commit | beda2c5f54a97c4e76c648120d2212705189a906 (patch) | |
| tree | 680767a0fba855e26799e392a59d4b0b6d8be4df /LUFA/Drivers/Peripheral/Serial.h | |
| parent | 0a7816059e8606337381c8d9c70f3f0bb68da52e (diff) | |
Added basic driver example use code to the library documentation.
Made the USARTStream global public and documented in the SerialStream module, allowing for the serial USART stream to be accessed via its handle rather than via the implicit stdout and stdin streams.
git-svn-id: http://lufa-lib.googlecode.com/svn/trunk@1615 d5102386-fcda-11dd-9fdb-3debd5008f28
Diffstat (limited to 'LUFA/Drivers/Peripheral/Serial.h')
| -rw-r--r-- | LUFA/Drivers/Peripheral/Serial.h | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/LUFA/Drivers/Peripheral/Serial.h b/LUFA/Drivers/Peripheral/Serial.h index 2fca02b9..f40201de 100644 --- a/LUFA/Drivers/Peripheral/Serial.h +++ b/LUFA/Drivers/Peripheral/Serial.h @@ -45,6 +45,18 @@ * Hardware serial USART driver. This module provides an easy to use driver for * the setup of and transfer of data over the AVR's USART port. * + * <b>Example Usage:</b> + * \code + * // Initialise the serial USART driver before first use, with 9600 baud (and no double-speed mode) + * Serial_Init(9600, false); + * + * // Send a string through the USART + * Serial_TxString("Test String\r\n"); + * + * // Receive a byte through the USART + * uint8_t DataByte = Serial_RxByte(); + * \endcode + * * @{ */ |