From 8dd9a40f779b353e64a5da3753f4136bc627b575 Mon Sep 17 00:00:00 2001 From: HomeSpan Date: Sat, 18 Dec 2021 15:26:33 -0600 Subject: [PATCH] Update Reference.md --- docs/Reference.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/Reference.md b/docs/Reference.md index d10cbaf..c4c1736 100644 --- a/docs/Reference.md +++ b/docs/Reference.md @@ -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 * 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)*