diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 9ba9508..98168f0 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -7,6 +7,7 @@ 6. [Pairing to HomeKit](#pairing-to-homekit) 7. [Factory Reset](#factory-reset) 8. [Creating a Scannable Tag](#creating-a-scannable-tag) +9. [Status LED Flashing Reference](#status-led-flashing-reference) ## Introduction @@ -167,6 +168,20 @@ The box can be bigger or smaller as long as you keep the same proportions. For Note that if you can’t find *Scancardium* listed as a font choice in either the *Pages* or *Keynote* font dropdown boxes, select Format → Font → Show Fonts from the menu bar of the *Pages* or *Keynote* application to bring up a list of all installed fonts where you can search for, and select, *Scancardium*. +## Status LED Flashing Reference + +If a status LED has been connected and configured, HomeSpan will use flashing code to indicate different status. + +| Flash pattern | Description | +| --------------------------- | -------------------------------------------------------------------------- | +| LED off, no flashing | By default, no power, unless `setStatusAutoOff(timeout)` has been defined. | +| LED on, no flashing | All good. Device is connected to WiFi and paired. See [PAIRED](#paired). | +| 1-second flash every second | Attempting to connect to WiFi. See [CONNECTING](#connecting). | +| 1 flash every 3 seconds | No WiFi. See [NO-WIFI](#nowifi). | +| 2 flashes every 3 seconds | See [READY-TO-PAIR](#readytopair). | +| 10 flashes per second | The Control button is pressed. Once released, HomeSpan will either
- Enter [Device Configuration Mode](#device-configuration-mode).
- Exit _Device Configuration Mode_ executing the action selected based on the number of flashes.| + + --- [↩️](../README.md) Back to the Welcome page