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

Merge pull request #575 from frankonski/user-guide-toc 

Added table of content to User Guide
This commit is contained in:
HomeSpan 2023-05-13 16:52:06 -04:00 committed by GitHub
parent ade9a608e8 1c2ee2f5d2
commit b9e8209e4b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/UserGuide.md
View File

@ -1,5 +1,16 @@
# HomeSpan User Guide # HomeSpan User Guide
1. [Introduction](#introduction)
2. [Getting Started](#getting-started)
3. [HomeSpan Device States](#homespan-device-states)
4. [Device Configuration Mode](#device-configuration-mode)
5. [Setting HomeSpan WiFi Credentials and Setup Code](#setting-homespan-wifi-credentials-and-setup-code)
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
This guide explains how to set up and configure a HomeSpan device that has already been programmed to operate one or more appliances, including how to: This guide explains how to set up and configure a HomeSpan device that has already been programmed to operate one or more appliances, including how to:
* Determine the state of the device by observing the HomeSpan Status LED * Determine the state of the device by observing the HomeSpan Status LED
@ -83,7 +94,7 @@ To execute the selected Action press and hold the Control Button for 3 seconds,
If no Action has been executed within 120 seconds (2 minutes) of starting the Device Configuration Mode, Action 1 is automatically executed and the Device Configuration Mode is exited. If no Action has been executed within 120 seconds (2 minutes) of starting the Device Configuration Mode, Action 1 is automatically executed and the Device Configuration Mode is exited.
## Setting HomeSpan’s WiFi Credentials and Setup Code ## Setting HomeSpan WiFi Credentials and Setup Code
To configure a HomeSpace device to connect to your home WiFi network you must first connect your iPhone directly to the device so you can input your WiFi Credentials. This connection is made via a temporary WiFi network HomeSpan launches just for this purpose. To configure a HomeSpace device to connect to your home WiFi network you must first connect your iPhone directly to the device so you can input your WiFi Credentials. This connection is made via a temporary WiFi network HomeSpan launches just for this purpose.
@ -157,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*. 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<br>- Enter [Device Configuration Mode](#device-configuration-mode).<br>- Exit _Device Configuration Mode_ executing the action selected based on the number of flashes.|
--- ---
[↩️](../README.md) Back to the Welcome page [↩️](../README.md) Back to the Welcome page