From b53081dfc75644e3025eea38e283e03e54cc57f5 Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sat, 19 Jun 2021 08:39:55 -0500 Subject: [PATCH] Update CLI.md --- docs/CLI.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/CLI.md b/docs/CLI.md index 5510d42..348f798 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -85,8 +85,14 @@ In addition to listening for incoming HAP requests, HomeSpan also continuously p * 0 (minimal diagnostics), * 1 (all diagnostics), and * 2 (all diagnostics plus a real-time stream of all HAP communication between HomeSpan and any connected HomeKit Controllers). + +* **?** - prints a menu of all CLI commands + +### User-Defined Commands - --- +You can extend the HomeSpan CLI with custom functions using `SpanUserCommand()`. This class allows you to assign a single-character name to any custom function that will be called when you type the '@' symbol following by the single-character name into the CLI. For example, if you assigned the character 'K' to a custom function, you would type '@K' into the CLI to invoke it. This allows you to use any single-character name, even if that character is already used by HomeSpan for its built-in commands. The `SpanUserCommand` class also allows you to include a short text description of your function that will be added to the menu of commands when you type '?' into the CLI. See the the [API Reference](https://github.com/HomeSpan/HomeSpan/blob/dev/docs/Reference.md#spanusercommandchar-c-const-char-s-void-fconst-char-v) for full details. + +--- [↩️](README.md) Back to the Welcome page