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-12-18 15:26:33 -06:00 committed by GitHub
parent 715adf44f1
commit 8dd9a40f77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/Reference.md
View File

@ -256,6 +256,11 @@ The following methods are supported:
* returns a pointer to the Characteristic itself so that the method can be chained during instantiation * returns a pointer to the Characteristic itself so that the method can be chained during instantiation
* example: `(new Characteristic::ConfiguredName("HDMI 1"))->removePerms(PW);` * example: `(new Characteristic::ConfiguredName("HDMI 1"))->removePerms(PW);`
* `SpanCharacteristic *setDescription(const char *desc)`
* adds an optional description, *desc*, to a Characteristic, as described in HAP-R2 Table 6-3
* this field is generally used to provide information about custom Characteristics, but does not appear to be used in any way by the Home App
* returns a pointer to the Characteristic itself so that the method can be chained during instantiation
* example: `(new Characteristic::MyCustomChar())->setDescription("Tuner Frequency");`
## *SpanButton(int pin, uint16_t longTime, uint16_t singleTime, uint16_t doubleTime)* ## *SpanButton(int pin, uint16_t longTime, uint16_t singleTime, uint16_t doubleTime)*