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-11-12 06:58:06 -06:00 committed by GitHub
parent 8ffb62715e
commit 8c93ac2e35
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/Reference.md
View File

@ -235,20 +235,17 @@ The following methods are supported:
* example: `(new Characteristic::SecuritySystemTargetState())->setValidValues(3,0,1,3);` creates a new Valid Value list of length=3 containing the values 0, 1, and 3. This has the effect of informing HomeKit that a SecuritySystemTargetState value of 2 (Night Arm) is not valid and should not be shown as a choice in the Home App
* `SpanCharacteristic *setPerms(uint8_t perms)`
* changes the default permissions for a Characteristic to *perms*, where
* *perms* - additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
* changes the default permissions for a Characteristic to *perms*, where *perms* is an additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
* returns a pointer to the Characteristic itself so that the method can be chained during instantiation
* example: `(new Characteristic::IsConfigured(1))->setPerms(PW+PR+EV);`
* `SpanCharacteristic *addPerms(uint8_t perms)`
* adds new permissions, *perms*, to the default permissions for a Characteristic, where
* *perms* - additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
* adds new permissions, *perms*, to the default permissions for a Characteristic, where *perms* is an additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
* returns a pointer to the Characteristic itself so that the method can be chained during instantiation
* example: `(new Characteristic::IsConfigured(1))->addPerms(PW);`
* `SpanCharacteristic *removePerms(uint8_t perms)`
* removes permissions, *perms*, from the default permissions of a Characteristic, where
* *perms* - additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
* removes permissions, *perms*, from the default permissions of a Characteristic, where *perms* is an additive list of permissions as described in HAP-R2 Table 6-4. Valid values are PR, PW, EV, AA, TW, HD, and WR
* returns a pointer to the Characteristic itself so that the method can be chained during instantiation
* example: `(new Characteristic::ConfiguredName("HDMI 1"))->removePerms(PW);`