You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ You can find pre-compiled firmware images on the [releases](https://github.com/b
71
71
72
72
This project uses [WiFiManager](https://github.com/tzapu/WiFiManager) to avoid the need to hardcode AP credentials in the firmware.
73
73
74
-
When the ESP powers on, you should be able to see a network named "ESPXXXXX", with XXXXX being an identifier for your ESP. Connect to this AP and a window should pop up prompting you to enter WiFi credentials.
74
+
When the ESP powers on, you should be able to see a network named "ESPXXXXX", with XXXXX being an identifier for your ESP. Connect to this AP and a window should pop up prompting you to enter WiFi credentials. If your board has a built-in LED (or you wire up an LED), it will [flash to indicate the status](#led-status).
75
75
76
76
The network password is "**milightHub**".
77
77
@@ -89,6 +89,19 @@ The HTTP endpoints (shown below) will be fully functional at this point. You sho
89
89
90
90

91
91
92
+
## LED Status
93
+
94
+
Some ESP boards have a built-in LED, on pin #2. This LED will flash to indicate the current status of the hub:
95
+
96
+
* Fast flash (on/off once per second) means the Wifi is not configured. See [Configure Wifi](#configure-wifi) to configure the hub.
97
+
* Occasional blips of light (a flicker of light every 1.5 seconds) means the hub is on wifi and ready to operate.
98
+
* Rapid blips of light for brief periods (three rapid flashes) means packets are either detected from a device or are being sent to a device.
99
+
* Solid light means the Wifi waited to be configured and gave up, or something went wrong with wifi configuration.
100
+
101
+
You can configure the LED pin from the web console. Note that pin means the GPIO number, not the D number ... for example, D2 is actually GPIO4 and therefore its pin 4. If you specify the pin as a negative number, it will reverse the LED (the built-in LED on pin 2 is reversed, so the default is -2).
102
+
103
+
If you want to wire up your own LED on a pin, such as on D2/GPIO4, put a wire from D2 to one side of a 220 ohm resister. On the other side, connect it to the positive side (the longer wire) of a 3.3V LED. Then connect the negative side of the LED (the shorter wire) to ground. If you use a different voltage LED, or a high current LED, you will need to add a driver circuit.
104
+
92
105
## REST endpoints
93
106
94
107
1.`GET /`. Opens web UI.
@@ -234,3 +247,8 @@ You can select between versions 5 and 6 of the UDP protocol (documented [here](h
0 commit comments