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-05-30 07:08:36 -05:00 committed by GitHub
parent 4dfb881780
commit 5204eeaeef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/Reference.md
View File

@ -221,15 +221,13 @@ If REQUIRED is defined in the main sketch prior to including the HomeSpan librar
``` ```
--- ---
## *SpanRange(int min, int max, int step)* #### Deprecated functions (available for backwards compatibility with older sketches):
Creating an instance of this **class** overrides the default HAP range for a Characteristic with the *min*, *max*, and *step* values specified. [*SpanRange(int min, int max, int step)*](https://github.com/HomeSpan/HomeSpan/blob/release-1.2.0/docs/Reference.md#spanrangeint-min-int-max-int-step)
* instantiated Ranges are added to the HomeSpan HAP Database and associated with the last Characteristic instantiated * this legacy function is limited to integer-based parameters and has been re-coded to simply call the more generic `setRange(min, max, step)` method
* instantiating a Range without first instantiating a Characteristic throws an error during initialization * last supported version: v1.2.0
* example: `new Characteristic::Brightness(50); new SpanRange(10,100,5);` * **please use** `setRange(min, max, step)` **for all new sketches**
* 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**
--- ---