Skip to content

Commit df3b82a

Browse files
bb-Ricardobb-Ricardo
committed
updates documentation files for the next release
refs: NimmLor#145
1 parent a809331 commit df3b82a

File tree

3 files changed

+89
-55
lines changed

3 files changed

+89
-55
lines changed

‎Changelog.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Changelog
2+
3+
## 4.5 - XX.02.2021, Config web page, ESP32 support, Homey integration
4+
5+
### Features:
6+
- adds settings page to remove secrets.h and configure Wifi, hostname and MQTT settings #94
7+
- Homey integration #117
8+
- calculate delay per frame dynamically to keep frame rate steady #125
9+
- adds Serial DEBUG mode and improves DEBUG information #124
10+
- disable certain web interface controls if not available/used by pattern #92
11+
- Adds ESP32 support (experimental) #77
12+
13+
### Bugfixes:
14+
- fix compile errors when MQTT support was enabled #109
15+
- fixes problem with UDP visualization not working #103
16+
- fixes issue with unsaved config LEDs were power off #127
17+
- fixes duplicate open SSID after wifiManager connected #135
18+
- fixes random 4 seconds freezes #114
19+
- fixes an compile error if LED_DEVICE_TYPE 5 was selected #73
20+
- fixes Wifi setup if `LED_DEVICE_TYPE 2` was selected #100
21+
22+
### House keeping:
23+
- remove half integrated simple page #128
24+
- remove unused "webSockets" support #130
25+
- improves handling of config data written to EEPROM #121
26+
- general code cleanup #129
27+
28+
### Documentation
29+
- adds documentation of MQTT payload options #126, #137
30+
- adds documentation of all URL endpoints and their options #147
31+
- improves the list of dependencies and library versions #145
32+
33+
## 07.05.2020, Major Code rewrite and merge of projects, audio visualization
34+
35+
- **Audio Visualization with a Windows Desktop Application (C#, WPF)** [here](https://github.com/NimmLor/IoT-Audio-Visualization-Center)
36+
- multicast DNS by @WarDrake
37+
- OTA Support
38+
- MQTT/Homeassistant integration by @WarDrake
39+
- Serial Ambilight for usage behind a TV
40+
- Support of Desk Lamp, 7-Segment Clock, Animated RGB Logos, Generic LED-Strip
41+
- WebUI fits now on 1MB devices (esp-01)
42+
- Dark mode for WebUI
43+
44+
## 01.02.2020, Native Alexa Update
45+
46+
- **NodeRED** part is now **DEPRECATED**
47+
- The Nanoleaf Replica allows now for **NATIVE** Alexa support without the need of an extra Raspberry Pi. When added to the Smart Home devices in the Alexa app, the nanoleafs will appear as Phillips Hue devices.
48+
- Added Strobe Pattern
49+
- Added Sound Reactive support
50+
- Some code cleanup and new parameters to configure
51+
- New step by step installation instructions ([Software_Installation.md](Software_Installation.md))
52+
53+
## 24.02.2019, NodeRED Update (Deprecated)
54+
55+
- Node-RED integration was added
56+
- Alexa support via NodeRED

‎README.md

-32
Original file line numberDiff line numberDiff line change
@@ -79,38 +79,6 @@ All of my recent project were merged into one including most of the features. A
7979
* Project link, IoT Bottle Lighting Pad: https://www.thingiverse.com/thing:4461313
8080

8181

82-
83-
## Changelog
84-
85-
### 07.05.2020, Major Code rewrite and merge of projects, audio visualization
86-
87-
- **New features:**
88-
- **Audio Visualization with a Windows Desktop Application (C#, WPF)** [here](https://github.com/NimmLor/IoT-Audio-Visualization-Center)
89-
- multicast DNS by @WarDrake
90-
- OTA Support
91-
- MQTT/Homeassistant integration by @WarDrake
92-
- Serial Ambilight for usage behind a TV
93-
- Support of Desk Lamp, 7-Segment Clock, Animated RGB Logos, Generic LED-Strip
94-
- WebUI fits now on 1MB devices (esp-01)
95-
- Dark mode for WebUI
96-
97-
### 01.02.2020, Native Alexa Update
98-
99-
- **NodeRED** part is now **DEPRECATED**
100-
- The Nanoleaf Replica allows now for **NATIVE** Alexa support without the need of an extra Raspberry Pi. When added to the Smart Home devices in the Alexa app, the nanoleafs will appear as Phillips Hue devices.
101-
- Added Strobe Pattern
102-
- Added Sound Reactive support
103-
- Some code cleanup and new parameters to configure
104-
- New step by step installation instructions ([Software_Installation.md](Software_Installation.md))
105-
106-
107-
108-
### 24.02.2019, NodeRED Update (Deprecated)
109-
110-
- Node-RED integration was added
111-
- Alexa support via NodeRED
112-
113-
11482
Installation
11583
--------
11684
**FOR INSTALLATION REFER TO THE [Software_Installation.md](Software_Installation.md)**

‎Software_Installation.md

+33-23
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,28 @@ This document describes the necessary steps from setting up the development envi
44

55
ESP32 currently got experimental support.
66

7-
### Dependencies
8-
9-
- **esp8266 v2.7.x required**
10-
- FastLED v3.2.2+ required
11-
- ESP8266-FS (Sketch-Data-Uploader) version **[5.0+](https://github.com/esp8266/arduino-esp8266fs-plugin/releases)**
12-
- WiFiManager by tzapu **required**
13-
- (Optional) Espalexa library for Alexa integration
14-
- (Optional) ArduinoOTA library and Python 2.7 for wireless firmware updating
15-
- (Optional) PubSubClient and ArduinoJson libraries for MQTT/Homeassistant support
16-
- (Recommended) [IoT-Audio-Visualization-Center](https://github.com/NimmLor/IoT-Audio-Visualization-Center), Windows Application to sync the LEDs with music
17-
18-
7+
## Dependencies
8+
* esp8266 and esp32 libs have to be installed via board manager
9+
* alle other libs need to be installed via library manager
10+
11+
|Name|Version|Type|Comment|
12+
|----|-------|----|-------|
13+
esp8266|2.7.4|required|esp8266 Core Library if ESP8266 board is used
14+
esp32|1.0.4|required|esp32 Core Library if ESP32 board is used
15+
FastLED|3.4.0|required|LED animation library
16+
WiFiManager|2.0.3-alpha|required|easy WiFi setup integration
17+
Espalexa|2.5.0|optional|library for Alexa integration
18+
PubSubClient|2.8.0|optional|for MQTT/Homeassistant support
19+
ArduinoJson|6.17.2|optional|for MQTT/Homeassistant support
20+
ArduinoOTA|1.0.5|optional|library and Python 2.7 for wireless firmware updating
21+
Homeyduino|1.0.2|optional|for Homey Integration support
22+
23+
#### Sketch-Data-Uploader
24+
* ESP8266-FS: [0.5.0+](https://github.com/esp8266/arduino-esp8266fs-plugin/releases)
25+
* ESP32-FS: [1.0+](https://github.com/me-no-dev/arduino-esp32fs-plugin/releases/)
26+
27+
Recommended if desired\
28+
[IoT-Audio-Visualization-Center](https://github.com/NimmLor/IoT-Audio-Visualization-Center), Windows Application to sync the LEDs with music
1929

2030
**The software can be found on [GitHub](https://github.com/NimmLor/esp8266-fastled-iot-webserver).**
2131

@@ -81,8 +91,8 @@ The video wasn't updated for the new update, so the library versions are incorre
8191

8292
![](https://cdn.shopify.com/s/files/1/1509/1638/files/install_python_for_windows_customize_add_to_path.png?88791)
8393

84-
11. *(Optional)* Install PubSubClient and ArduinoJson for MQTT/Homeassistant support
85-
Click on *Sketch >> Include Library >> Manage Libraries* and install PubSubClient, version **2.7.0** and ArduinoJson version **6.15.1**
94+
11. *(Optional)* Install PubSubClient and ArduinoJson for MQTT/Homeassistant support\
95+
Click on *Sketch >> Include Library >> Manage Libraries* and install *PubSubClient* and *ArduinoJson*
8696

8797
![](software_screenshots/mqtt.png?raw=true)
8898

@@ -110,8 +120,7 @@ The video wasn't updated for the new update, so the library versions are incorre
110120
- `COLOR_ORDER`: Ordering of the colors sent, **depends on the LED-Strip**, if colors are swapped, then swap the Letters (RGB, RBG, GRB, GBR, BRG, BGR)
111121
- `MILLI_AMPS`: How much current your power supply can handle in mA
112122
- `VOLTS`: How much voltage your power supply delivers in Volts
113-
- `HOSTNAME`: Name of the Device, **don't use whitespaces, use "-" instead when enabling mDNS**
114-
- **Important**: `DEVICE_TYPE` defines what device you are using, see the list below the code and choose the number
123+
- **Important**: `LED_DEVICE_TYPE` defines what device you are using, see the list below the code and choose the number
115124

116125
![](software_screenshots/config.png?raw=true)
117126

@@ -184,7 +193,6 @@ Look for *ANIMATED RGB LOGO CONFIG* further down the code for configuration.
184193

185194
#### 2.3.1 Overview
186195

187-
- **ACCESS_POINT_MODE**: The esp8266 will function as an access point instead of connecting to one
188196
- **ENABLE_OTA_SUPPORT**: Enables the user to update the firmware wireless
189197
- **ENABLE_MULTICAST_DNS**: allows to access the UI via "http://<HOSTNAME>.local/"
190198
- **RANDOM_AUTOPLAY_PATTERN**: plays patterns at random in autoplay mode
@@ -193,7 +201,8 @@ Look for *ANIMATED RGB LOGO CONFIG* further down the code for configuration.
193201
- **SOUND_SENSOR_SUPPORT**: (LEGACY!) Allows to control the LEDs via a physical sound sensor
194202
- **ENABLE_SERIAL_AMBILIGHT**: Allows to be connected to a [Lightpack](https://github.com/psieg/Lightpack) (Windows, free) or [Ambient light Application for Android](https://play.google.com/store/apps/details?id=com.sevson.androidambiapp&hl=de_AT) (Android Smart TVs, 2,79€)
195203
- **ENABLE_MQTT_SUPPORT**: allows integration in homeassistant, requires MQTT server
196-
204+
- **ENABLE_UDP_VISUALIZATION**: Enables patters used for visualization via [IoT-Audio-Visualization-Center](https://github.com/NimmLor/IoT-Audio-Visualization-Center)
205+
- **ENABLE_HOMEY_SUPPORT**: enables support for integration with a Homey hub
197206

198207

199208
#### 2.3.2 OTA support
@@ -205,30 +214,31 @@ Look for *ANIMATED RGB LOGO CONFIG* further down the code for configuration.
205214
![](software_Screenshots/ota.png?raw=true)
206215

207216

208-
209217
#### 2.3.3 Alexa integration
210218

211219
6. Requires the **Espalexa** library
212220

213-
- The name of the device is set in the variable `ALEXA_DEVICE_NAME`
214221
- Configuration of addition Devices
215222

216223
- In order to control more parameters, the code allows to create additional devices that control, for instance a specific pattern or the autoplay functionality
217-
- The specific pattern refers to the zero-based index of the patterns array, just count up to your desired pattern, ignore patterns that are commented out or aren't affected by the `DEVICE_TYPE`
224+
- The specific pattern refers to the zero-based index of the patterns array, just count up to your desired pattern, ignore patterns that are commented out or aren't affected by the `LED_DEVICE_TYPE`
218225
- To make use of these features remove the `//` in front of the `#define ...`
219226

220227
![](software_screenshots/alexa_config.png?raw=true)
221228

222229

223-
224-
#### 2.3.4 MQTT configuration
230+
#### 2.3.4 MQTT integration
225231

226232
- Installation of "PubSubClient" and "ArduinoJson" libraries required
227233
- Requires `ENABLE_MQTT_SUPPORT`
228234
- It's preconfigured for Home Assistant Mosquitto MQTT service
229235
- Enables sync with home assistant and from there to Google Assistant
230236

237+
#### 2.3.5 Homey integration
231238

239+
- Installation of "Homeyduino" library required
240+
- Requires `ENABLE_HOMEY_SUPPORT`
241+
- Enables integration with homey pod
232242

233243
## 3. Upload
234244

0 commit comments

Comments
 (0)