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

Update Reference.md

This commit is contained in:
HomeSpan 2022-11-05 11:51:00 -04:00 committed by GitHub
parent 6763b2a79b
commit 22a004e315
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/Reference.md
View File

@ -150,10 +150,10 @@ The following **optional** `homeSpan` methods enable additional features and pro
* sets an optional user-defined callback function, *func*, to be called by HomeSpan whenever its running state (e.g. WiFi Connecting, Pairing Needed...) changes in way that would alter the blinking pattern of the (optional) Status LED * sets an optional user-defined callback function, *func*, to be called by HomeSpan whenever its running state (e.g. WiFi Connecting, Pairing Needed...) changes in way that would alter the blinking pattern of the (optional) Status LED
* if *func* is set, it will be called regardless of whether or not a Status LED has actually been defined * if *func* is set, it will be called regardless of whether or not a Status LED has actually been defined
* this allows users to reflect changes to the current state of HomeSpan using alternative methods, such as outputting messages to an embedded LCD or E-Ink display * this allows users to reflect changes to the current state of HomeSpan using alternative methods, such as outputting messages to an embedded LCD or E-Ink display
* the function *func* must be of type *void* and accept one argument of enum type *HS_STATUS* * the function *func* must be of type *void* and accept one argument of enum type [HS_STATUS](HS_STATUS.md)
* `char* statusString(HS_STATUS s)` * `char* statusString(HS_STATUS s)`
* returns a pre-defined character string message representing *s*, which must be of enum type *HS_STATUS* * returns a pre-defined character string message representing *s*, which must be of enum type [HS_STATUS](HS_STATUS.md)
* typically used in conjunction with `setStatusCallback()` above * typically used in conjunction with `setStatusCallback()` above
* `void setPairingCode(const char *s)` * `void setPairingCode(const char *s)`