From 37e01daed07990b4b042ccd7b756335362ecc296 Mon Sep 17 00:00:00 2001 From: Rodrigo Alfonso Date: Sun, 21 Apr 2024 19:00:32 -0300 Subject: [PATCH] Updating UART docs --- README.md | 2 +- lib/LinkUART.hpp | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 0dda131..7930229 100644 --- a/README.md +++ b/README.md @@ -360,7 +360,7 @@ Name | Return type | Description `isActive()` | **bool** | Returns whether the library is active or not. `activate(baudRate, dataSize, parity, useCTS)` | - | Activates the library using a specific UART mode. _Defaults: 9600bps, 8-bit data, no parity bit, no CTS_. `deactivate()` | - | Deactivates the library. -`sendLine(string)` | - | Receives a null-terminated `string`, and sends the string followed by a `'\n'` character. The null character is not sent. +`sendLine(string)` | - | Takes a null-terminated `string`, and sends it followed by a `'\n'` character. The null character is not sent. `sendLine(data, cancel)` | - | Like `sendLine(string)` but accepts a `cancel()` function. The library will continuously invoke it, and abort the transfer if it returns `true`. `readLine(string, [limit])` | **bool** | Reads characters into `string` until finding a `'\n'` character or a character `limit` is reached. A null terminator is added at the end. Returns `false` if the limit has been reached without finding a newline character. `readLine(string, cancel, [limit])` | - | Like `readLine(string, [limit])` but accepts a `cancel()` function. The library will continuously invoke it, and abort the transfer if it returns `true`. diff --git a/lib/LinkUART.hpp b/lib/LinkUART.hpp index f3303f9..9423195 100644 --- a/lib/LinkUART.hpp +++ b/lib/LinkUART.hpp @@ -24,7 +24,6 @@ // (see examples) // -------------------------------------------------------------------------- -#include #include // Buffer size