From bf82209a7b7164806c7e28b9a5a3537101c8a0cb Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sat, 13 May 2023 15:38:39 -0500 Subject: [PATCH] Update Reference.md --- docs/Reference.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/Reference.md b/docs/Reference.md index 87f454e..d4c76e6 100644 --- a/docs/Reference.md +++ b/docs/Reference.md @@ -205,6 +205,15 @@ The following **optional** `homeSpan` methods enable additional features and pro * example: `homeSpan.processSerialCommand("A");` starts the HomeSpan Setup Access Point * example: `homeSpan.processSerialCommand("Q HUB3");` changes the HomeKit Setup ID for QR Codes to "HUB3" +* `void setSerialInputDisable(boolean val)` + * if *val* is true, disables HomeSpan from reading input from the Serial port + * if *val* is false, re-enables HomeSpan reading input from the Serial port + * useful when the main USB Serial port is needed for reading data from an external Serial peripheral, rather than being used to read input from the Arduino Serial Monitor + + * `boolean getSerialInputDisable()` + * returns *true* if HomeSpan reading from the Serial port is currently disabled + * returns *false* if HomeSpan is operating normally and will read any CLI commands input into the Arduino Serial Monitor + --- The following **optional** `homeSpan` methods provide additional run-time functionality for more advanced use cases: