1.1 Flashing

There are several possibilities to flash your controller, but most commonly you want to either flash pre-compiled binaries or compile the binaries yourself and flash them afterward.

The pre-compiled binaries provided via github are generated by an automatic build process (TRAVIS-CI) whenever a new version is released. This ensures, that the binaries have not been modified in any sense or include code that might be harmful.

Precompiled rom and filesystems

In order to flash your controller, you will need:

• A usb2serial logic level converter (i.e FTDI232 )
• esptool (espressif SDK) or a different tool for flashing the esp
• precompiled binaries

Steps for ESPTOOL

• copy esptool to the directory of the extracted firmware files
• replace COMPORT with the port of your Serial programmer in the following code and execute it

esptool -p COMPORT -b 115200 write_flash -ff 40m -fm qio -fs 32m 0x00000 rboot.bin 0x02000 rom0.bin 0x100000 spiff_rom.bin

After successfully flashing it is recommended to reset the controller (via reset button or by cycling the power)

Compiling yourself

This option is only recommended if you have experience in setting up your own development environments, are comfortable using git/commandline tools/make

In order to compile the binaries, you need:

• SMING development environment (for setup guides check the SMING Wiki)
• Modified Sming Framework (patrickjahns/Sming branch rgbwwdev)
• RGBWWLed

If you want to include the webapplication, you also need:

• esp_rgbww_webinterface source
• A working nodejs and grunt environment

Steps

1. Setup your development environments
   This step assumes that you already have a working SMING development environment.

• Change your SMING installation to use this fork https://github.com/patrickjahns/Sming/tree/rgbwwdev

In your SMING directory execute the following commands:

git remote add rgbwwdev https://github.com/patrickjahns/Sming.git
git pull rgbwwdev
git checkout rgbwwdev/rgbwwdev

• Add the RGBWW Library into the SMING framework path: Sming/Libraries/RGBWWLED

cd Sming/Libraries
git clone https://github.com/patrickjahns/RGBWWLed.git

• Recompile your SMING framework (make clean && make all)

2. Prepare the Firmware

• Clone the firmware repository to your local filesystem
• Add the project to eclipse

3. Prepare the Webinterface (optional - skip this step if you don`t want to use the webinterface)

• From release
  • Download the release files
  • Copy the webfiles (index.html.gz, init.html.gz, app.min.css.gz, app.min.js.gz) to the folder webapp in your firmware directory
• From sourcecode (requires nodejs and bower)
  • Clone esp_rgbww_webinterface
  • Open a command/terminal in the esp_rgbww_webinterface directory and run npm run release to create the distribution files for the webinterface
  • Copy the resulting files from dist to the firmware project into the folder webapp in your firmware directory (esp_rgbww_firmware/webapp). If the folder webapp does not exist, create it

4. Make and Flash
   If you have followed the instructions until here, you can now compile your own version of the firmware via running make flash

After successfully flashing it is recommended to reset the controller (via reset button or by cycling the power)