From 6763b2a79baecfa3a59e8e2f06ae9e8bc3cf0e9a Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sat, 5 Nov 2022 11:48:15 -0400 Subject: [PATCH] Update HS_STATUS.md --- docs/HS_STATUS.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/HS_STATUS.md b/docs/HS_STATUS.md index abc35d1..7e0267e 100644 --- a/docs/HS_STATUS.md +++ b/docs/HS_STATUS.md @@ -1,6 +1,6 @@ # HomeSpan Status -The optional *homeSpan* method, `void setStatusCallback(void (*func)(HS_STATUS status))`, can be used to create a callback function, *func*, that HomeSpan calls whenever its status changes. HomeSpan passes *func* a single argument, *status*, of type *HS_STATUS*, defined as follows: +The optional ***homeSpan*** method, `void setStatusCallback(void (*func)(HS_STATUS status))`, can be used to create a callback function, *func*, that HomeSpan calls whenever its status changes. HomeSpan passes *func* a single argument, *status*, of type *HS_STATUS*, defined as follows: ```C++ enum HS_STATUS { @@ -28,7 +28,7 @@ enum HS_STATUS { }; ``` -The *homeSpan* method `char* statusString(HS_STATUS s)`, is a convenience function for converting any of the above enumerations to short, pre-defined character string messages as follows: +The ***homeSpan*** method `char* statusString(HS_STATUS s)`, is a convenience function for converting any of the above enumerations to short, pre-defined character string messages as follows: ```C++ const char* Span::statusString(HS_STATUS s){ @@ -59,6 +59,8 @@ const char* Span::statusString(HS_STATUS s){ } ``` +You can of course create any alternative messsages, or take any actions desired, in *func* and do not need to use the pre-defined strings above. + --- [↩️](Reference.md) Back to the Reference API page