|
| 1 | +# ESPEGI |
| 2 | +Espegi is an alternative firmware for ESP8266 based devices like iTead Sonoff with web UI, OTA updates, and Blynk support. |
| 3 | +<br><br> |
| 4 | +<img src="https://static.tildacdn.com/tild3830-6364-4266-a638-356563636132/Blynk_logo_diamond.png" width="15%"/> |
| 5 | +<img src="https://www.espressif.com/sites/all/themes/espressif/logo.svg" width="30%"/> |
| 6 | + |
| 7 | +# Features |
| 8 | +Espegi is mainly focused on controlling a Sonoff, but with simple tweaks (in the config.h file) can be adapted to any ESP8266 based device. |
| 9 | +##### Web UI |
| 10 | +The first feature is the Web UI (insipred by the famous tasmota firmware). Is simple as possible, you just got the status of the relay, the temperature and humidity (if you have a sensor), a toggle button and the OTA upgrade button.<br> |
| 11 | +<img src="images/webUI.png" width="60%"/> |
| 12 | + |
| 13 | +##### Blynk |
| 14 | +Obviously, since it has Blynk support you can controll it through the app (by default the relay pin is V0, but you can change it). |
| 15 | + |
| 16 | +##### Scripting / Command line |
| 17 | +Another feature is the ease of control through scripting languages and/or command line: |
| 18 | +1. You can easily toggle the relay with ```<IP address>/togglecmd``` |
| 19 | +2. You can get the current temperature by typing ```<IP address>/temperaturecmd```, in "text/plain" format<br> (ex. ```26.30°C, 42.10%```) |
| 20 | + |
| 21 | +You can find examples in the "example scripts" folder. |
| 22 | + |
| 23 | +# How to install |
| 24 | +Flashing is quite easy (if you need more information look up tasmota flashing on google): |
| 25 | + |
| 26 | +1. Download the repo |
| 27 | +2. Edit the config.h file with your data (WiFi SSID, password, Blynk key, etc.); more information on this later. |
| 28 | +3. Open the Arduino IDE and install the required board/libraries |
| 29 | + |
| 30 | +#### Install ESP8266 board software |
| 31 | +- Open Arduino IDE and select ```File``` → ```Preferences``` (```Arduino``` → ```Preferences``` on Mac) and add the following text for field Additional Boards Manager URLs: ```http://arduino.esp8266.com/stable/package_esp8266com_index.json``` and select OK. |
| 32 | +- ```Open Tools``` → ```Boards..```. → ```Boards Manager...``` and scroll down and click on esp8266 by ESP8266 Community. Click the Install button to download and install the latest ESP8266 board software. Select Close. |
| 33 | +<br><br> |
| 34 | +4. Install the Blynk library (```Sketch``` → ```#include library``` → ```Manage libraries```), and if you need it, the DHT and Adafruit Unified Sensor library. |
| 35 | +5. Follow this flash settings, and upload the firmware (if you need to upload to a sonoff, before plugging it into the PC you have to put it in flash mode, by holding down the button while plugging it in). Surely the most important settings are: "Flash size", "Flash Mode" and "IwIP Variant". Set them right or the firmware might not work.<br><br> |
| 36 | + |
| 37 | +6. Finished! Now look up on the router for the new IP address (Hostname: ESPEGI), type it in a browser, and you'll find the Web UI! |
| 38 | + |
| 39 | +# Config file |
| 40 | +The configuration file (the only you have to change) is fairly easy: |
| 41 | + |
| 42 | +If you want a DHT sensor, leave it like this, otherwise comment it out with ```//```<br> |
| 43 | +```#define DHT_SENSOR``` |
| 44 | + |
| 45 | +Blynk auth key:<br> |
| 46 | +```char auth[] = "";``` |
| 47 | + |
| 48 | +Thingspeak API key (only if you use a DHT sensor):<br> |
| 49 | +```String TS_API_KEY = "";``` |
| 50 | + |
| 51 | +Wi-Fi Details:<br> |
| 52 | +``` |
| 53 | +char ssid[] = ""; |
| 54 | +char wifiPassword[] = ""; |
| 55 | +char HOSTNAME[] = "ESPEGI"; |
| 56 | +
|
| 57 | +String ota_username = "admin"; |
| 58 | +String ota_password = "admin"; |
| 59 | +``` |
| 60 | + |
| 61 | +Finally you have the ESP8266 pins (RELAY_PIN, LED_PIN, etc...), and the Blynk's virtual pins (RELAY_VPIN, etc...) |
0 commit comments