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

Update Reference.md

This commit is contained in:
HomeSpan 2023-10-28 09:06:51 -05:00 committed by GitHub
parent 0f96d0fff6
commit 2d84f25ac4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Reference.md
View File

@ -209,6 +209,12 @@ The following **optional** `homeSpan` methods enable additional features and pro
* sets the format of the HomeSpan Web Log to the custom style sheet specified by *css* * sets the format of the HomeSpan Web Log to the custom style sheet specified by *css*
* see [Message Logging](Logging.md) for details on how to construct *css* * see [Message Logging](Logging.md) for details on how to construct *css*
* `Span& setWebLogCallback(void (*func)(String &htmlText))`
* sets an optional user-defined callback function, *func*, to be called by HomeSpan whenever the Web Log is produced
* allows user to add additional custom data to the initial table of the Web Log by **extending** the String *htmlText*, which is passed as a reference to *func*
* the function *func* must be of type *void* and accept one argument of type String
* see [Message Logging](Logging.md) for details on how to construct *htmlText*
* `void processSerialCommand(const char *CLIcommand)` * `void processSerialCommand(const char *CLIcommand)`
* processes the *CLIcommand* just as if were typed into the Serial Monitor * processes the *CLIcommand* just as if were typed into the Serial Monitor
* allows for programmatic access to all CLI commands, included any custom commands defined by the user * allows for programmatic access to all CLI commands, included any custom commands defined by the user