diff --git a/Software_Installation.md b/Software_Installation.md index 93f0867d4ab1eb547a97158b251d85ebd8103463..0d4794c6a568ef417037c5f132b46421855960fa 100644 --- a/Software_Installation.md +++ b/Software_Installation.md @@ -7,6 +7,7 @@ This document describes the necessary steps from setting up the development envi - **esp8266 v2.7.x required** - FastLED v3.2.2+ required - ESP8266-FS (Sketch-Data-Uploader) version **[5.0+](https://github.com/esp8266/arduino-esp8266fs-plugin/releases)** +- WiFiManager by tzapu **required** - (Optional) Espalexa library for Alexa integration - (Optional) ArduinoOTA library and Python 2.7 for wireless firmware updating - (Optional) PubSubClient and ArduinoJson libraries for MQTT/Homeassistant support @@ -44,8 +45,13 @@ The video wasn't updated for the new update, so the library versions are incorre Click on *Sketch >> Include Library >> Manage Libraries* and install **FastLED, version 3.3.2**  + +6. Install the **WiFiManager by Tapzu** + Click on *Sketch >> Include Library >> Manage Libraries* and install **WiFiManager by Tapzu** + +  -6. Install the *ESP8266FS* **Sketch Data Upload Tool**: +7. Install the *ESP8266FS* **Sketch Data Upload Tool**: > - Download the tool: https://github.com/esp8266/arduino-esp8266fs-plugin/releases. > @@ -57,21 +63,21 @@ The video wasn't updated for the new update, so the library versions are incorre > > // [source]( http://arduino.esp8266.com/Arduino/versions/2.3.0/doc/filesystem.html#uploading-files-to-file-system ) -7. *(Optional)* Install *Espalexa* for Amazon Alexa Support +8. *(Optional)* Install *Espalexa* for Amazon Alexa Support Click on *Sketch >> Include Library >> Manage Libraries* and install **Espalexa, version 2.4.4**  -8. *(Optional)* Install ArduinoOTA for flashing the ESP8266 via WiFi (requires Python 2.7) +9. *(Optional)* Install ArduinoOTA for flashing the ESP8266 via WiFi (requires Python 2.7) Click on *Sketch >> Include Library >> Manage Libraries* and install **ArduinoOTA**  -9. (Optional) Install Python for OTA and add it to Path, afterwards restart your PC +10. (Optional) Install Python for OTA and add it to Path, afterwards restart your PC  -10. *(Optional)* Install PubSubClient and ArduinoJson for MQTT/Homeassistant support +11. *(Optional)* Install PubSubClient and ArduinoJson for MQTT/Homeassistant support Click on *Sketch >> Include Library >> Manage Libraries* and install PubSubClient, version **2.7.0** and ArduinoJson version **6.15.1**  @@ -88,29 +94,9 @@ The video wasn't updated for the new update, so the library versions are incorre 2. Open the **.ino** file inside the folder in the Arduino IDE -3. Create the **Secrets.h** file, if the repository was cloned - *Top Right Corner >> New Tab >> "Secrets.h"* - -  - -4. Paste the following code and fill in your WiFi credentials, if you need MQTT fill in the credentials too - - ```c++ - // AP mode password - const char WiFiAPPSK[] = "your-password"; - - // Wi-Fi network to connect to (if not in AP mode) - char* ssid = "your-ssid"; - char* password = "your-password"; - - // only required when MQTT is enabled - const char* mqttUser = "YourMqttUser"; - const char* mqttPassword = "YourMqttUserPassword"; - ``` - -  +3. **Secrets.h was replaced by WiFiManager** -5. Configure the main parameters +4. Configure the main parameters In the esp8266-fastled-iot-webserver.ino file there are many parameters to change and tweak the essential settings are: - `LED_TYPE`: The type of LED strip that is used (WS2812B, APA102, ...) - `DATA_PIN`: The pin where the LED-Strip is connected @@ -268,12 +254,15 @@ Click on *Tools >> ESP8266 Sketch Data Upload* ### 3.3 Connecting to the esp8266 -1. Open the **Serial Monitor** to find the IP address of esp8266 +1. The ESP should open an access point with the hostname, connect to it + +2. Open **192.168.4.1** in your browser of choice + +3. Connect to your WiFi -- Click on *Tools >> Serial Monitor* -- When pressing the *Reset-Button* on the esp8266, the console should print the IP-Address +  -5. Connect to the UI by opening http://ip_address/ in your browser of choice, this works on mobile devices too. If mDNS was enabled, you should be able to access the UI via http://<Hostname>.local/ +4. Connect to the UI in your selected network by opening `http://<IP-ADDRESS>/` in your browser of choice. If mDNS was enabled, you should be able to access the UI via `http://<Hostname>.local/`