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

Update Reference.md

This commit is contained in:
HomeSpan 2022-02-11 09:08:29 -06:00 committed by GitHub
parent e0855e9b52
commit a198de8de9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Reference.md
View File

@ -86,7 +86,7 @@ The following **optional** `homeSpan` methods override various HomeSpan initiali
--- ---
The following **optional** `homeSpan` methods enable additional features and provide for further customization of the HomeSpan environment: The following **optional** `homeSpan` methods enable additional features and provide for further customization of the HomeSpan environment and **should** be called before `begin()` to take effect:
* `void enableOTA(boolean auth=true)` * `void enableOTA(boolean auth=true)`
* enables [Over-the-Air (OTA) Updating](OTA.md) of a HomeSpan device, which is otherwise disabled * enables [Over-the-Air (OTA) Updating](OTA.md) of a HomeSpan device, which is otherwise disabled
@ -376,7 +376,9 @@ Note that Custom Characteristics must be created prior to calling `homeSpan.begi
* `void homeSpan.setMaxConnections(uint8_t nCon)` * `void homeSpan.setMaxConnections(uint8_t nCon)`
* this legacy method was used to set the total number of HAP Controller Connections HomeSpan implements upon start-up to ensure there are still free sockets available for user-defined code requiring separate network resources * this legacy method was used to set the total number of HAP Controller Connections HomeSpan implements upon start-up to ensure there are still free sockets available for user-defined code requiring separate network resources
* this has been replaces by the more flexible method, `reserveSocketConnections(uint8_t nSockets)`, that allows you to simply reserve network sockets for other functions as needed - HomeSpan will then automarically determine how many sockts are left that it can use for HAP Controller Connections * this has been replaces by the more flexible method, `reserveSocketConnections(uint8_t nSockets)`
* allows you to simply reserve network sockets for other custom code as needed
* HomeSpan will then automatically determine how many sockets are left that it can use for HAP Controller Connections
* last supported version: [v1.4.2](https://github.com/HomeSpan/HomeSpan/blob/release-1.2.0/docs/Reference.md) * last supported version: [v1.4.2](https://github.com/HomeSpan/HomeSpan/blob/release-1.2.0/docs/Reference.md)
* **please use** `homeSpan.reserveSocketConnections(uint8_t nSockets)` **for all new sketches** * **please use** `homeSpan.reserveSocketConnections(uint8_t nSockets)` **for all new sketches**