Seich
/
HomeSpan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CLI.md

This commit is contained in:
HomeSpan 2021-06-19 08:39:55 -05:00 committed by GitHub
parent 67fd691ede
commit b53081dfc7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/CLI.md
View File

@ -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