diff --git a/docs/Reference.md b/docs/Reference.md index 5597a19..44b2d64 100644 --- a/docs/Reference.md +++ b/docs/Reference.md @@ -10,10 +10,13 @@ At runtime this HomeSpan will create a global object named `homeSpan` that suppo * `void begin(Category catID, char *displayName, char *hostNameBase, char *modelName);` * Initializes HomeSpan - * **Must** be called at the beginning of each sketch before any other HomeSpan functions + * **Must** be called at the beginning of each sketch (typically in `setup()`) before any other HomeSpan functions * All arguments are **optional** * *catID* - the HAP Category HomeSpan broadcasts for pairing to HomeKit. Default is [Category::Lighting](Categories.md) * *displayName* - the MDNS display name broadcast by HomeSpan. Default is "HomeSpan Server" * *hostNameBase* - the full MDNS host name is broadcast by HomeSpan as *hostNameBase-DeviceID*.local, where DeviceID is a unique 6-byte code generated automatically by HomeSpan. Default is "HomeSpan" * *modelName* - the HAP model name HomeSpan broadcasts for pairing to HomeKit. Default is "HomeSpan-ESP32" - + + * `void poll()` + * Checks for HAP requests, local commands, and device activity + * **Must** be called repeatedly in each sketch (typically placed at the top of `loop()`)