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

Update Reference.md

This commit is contained in:
HomeSpan 2020-11-26 08:01:50 -06:00 committed by GitHub
parent c742e86849
commit ef2b672f91
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/Reference.md
View File

@ -95,6 +95,12 @@ This is a **base class** from which all HomeSpan Characteristics are derived, an
* instantiated Characteristics are added to the HomeSpan HAP Database and associated with the last Service instantiated * instantiated Characteristics are added to the HomeSpan HAP Database and associated with the last Service instantiated
* instantiating a Characteristic without first instantiating a Service throws an error during initialization * instantiating a Characteristic without first instantiating a Service throws an error during initialization
* a single, optional argument is used to set the initial value of the Characteristic at startup. * a single, optional argument is used to set the initial value of the Characteristic at startup
* example: `new Characteristic::Brightness(50);` * example: `new Characteristic::Brightness(50);`
The following methods are supported:
* `type T getVal<T>()`
* a template method that returns the current value of the Characteristic, after casting into the type *T* specified (e.g. *int*, *double*, etc.). If template parameter is excluded, value will be cast to *int*.
* Example with template specified: `double temp = Characteristic::CurrentTemperature->getVal<double>();`
* Example with template excluded : `int tilt = Characteristic::CurrentTiltAngle->getVal();`