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

Update Reference.md

This commit is contained in:
HomeSpan 2021-03-07 08:45:24 -06:00 committed by GitHub
parent ff0dfefc47
commit 2f8cd511dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/Reference.md
View File

@ -172,13 +172,14 @@ The following methods are supported:
* `int timeVal()` * `int timeVal()`
* returns time elapsed (in millis) since value of the Characteristic was last updated (whether by `setVal()` or as the result of a successful update request from a HomeKit Controller) * returns time elapsed (in millis) since value of the Characteristic was last updated (whether by `setVal()` or as the result of a successful update request from a HomeKit Controller)
## *SpanRange(int min, int max, int step)* * `SpanCharacteristic *setRange(min, max, step)`
* overrides the default HAP range for a Characteristic with the *min*, *max*, and *step* values specified
Creating an instance of this **class** overrides the default HAP range for a Characteristic with the *min*, *max*, and *step* values specified. * only applicable for Characteristics that support value ranges, else error is thrown
* can only set set once per Characteristic. Calling setRange twice for the same Characteristic throws an error
* instantiated Ranges are added to the HomeSpan HAP Database and associated with the last Characteristic instantiated * works with any integer or floating-based parameters, though HomeSpan will recast the values into the appropriate format for the Characteristic, which means if you specify *step*=0.5 for a UINT8 Characteristic, *step* will be truncated to zero
* instantiating a Range without first instantiating a Characteristic throws an error during initialization * *step* is an optional parameter. If unspecified, or set to zero or a negative number, the default HAP step size remains unchanged
* example: `new Characteristic::Brightness(50); new SpanRange(10,100,5);` * Returns a pointer to the Characteristic itself so that the method can be chained during instantiation
* example: `(new Characteristic::Brightness(50))->setRange(10,100,5);`
## *SpanButton(int pin, uint16_t longTime, uint16_t singleTime, uint16_t doubleTime)* ## *SpanButton(int pin, uint16_t longTime, uint16_t singleTime, uint16_t doubleTime)*
@ -213,6 +214,15 @@ If REQUIRED is defined in the main sketch prior to including the HomeSpan librar
```C++ ```C++
#define REQUIRED VERISON(2,1,3) // throws a compile-time error unless HomeSpan library used is version 2.1.3 or later #define REQUIRED VERISON(2,1,3) // throws a compile-time error unless HomeSpan library used is version 2.1.3 or later
``` ```
### *SpanRange(int min, int max, int step)*
Creating an instance of this **class** overrides the default HAP range for a Characteristic with the *min*, *max*, and *step* values specified.
* instantiated Ranges are added to the HomeSpan HAP Database and associated with the last Characteristic instantiated
* instantiating a Range without first instantiating a Characteristic throws an error during initialization
* example: `new Characteristic::Brightness(50); new SpanRange(10,100,5);`
* **this is a legacy function that is limited to integer-based parameters, and has been re-coded to simply call the more generic `setRange(min, max, step)` method**
* **please use setRange(min, max, step) for all new sketches**
--- ---