witska / liana-lt

Light animation using ESP8266 and WS2812 LEDs

Projektas Liana: ESP8266 / WS2812 šviesos animacija

Autorius Vasil-Pahomov

Nuo ko pradėti

1. Prijunkite ESP, LED juostą (girliandą) ir maitinimo šaltinį, kaip parodyta toliau (Pajungimas)
2. Įkelkite failus: programos failą 0x000000 ir SPIFFS failą 0x100000. Turėtumėte pakoreguoti plokštės nustatymus, ypač COM prievado numerį, atminties dydį ir SPI režimą. Naudojau oficialius įrankius Flash download tools (juos galite rasti čia), o mano veikiantys NodeMCU plokštės nustatymai atrodo taip:

3. Prisijunkite prie Liana belaidžio tinklo ir bakstelėkite iškylantį autorizacijos skydelį. Būsite nukreipti tiesiai į Liana naršyklės sąsają. Jei skydelis neatsidarė, naršyklėje eikite į http://192.168.4.1/. Čia galite sukonfigūruoti ryšį su namų Wi-Fi tinklu.
4. Prijungę Lianą prie Wi-Fi, atidarykite naršyklėje http://liana.local iš bet kurio iOS, MacOS ar Windows įrenginio, esančio tame pačiame tinkle. Tai neveikia su Android, tačiau turėtumėte rasti Liana IP adresą (pvz., maršrutizatoriaus administratoriaus pulte, matydami Liana COM prievado išvestį po paleidimo arba naudodami mDNS klientą, pvz., .Local Finder). Tada Android naršyklėje įveskite http://<IP_ADDRESS>.

Pajungimas

NodeMCU plokštė parodyta kaip pavyzdys, tačiau galima naudoti bet kurią plokštę su ESP8266. Atminkite, kad kitoms plokštėms gali tekti perkompiliuoti kodą! Jūs užmaitinate plokštę, užmaitinate WS2812 grandinę ir prijungiate ESP GPIO2 išvestį prie pirmosios WS2812 grandinės duomenų įvesties, tai viskas. Įsitikinkite, kad naudojate tinkamą maitinimo šaltinį, dauguma ESP8266 plokščių turi įtampos stabilizatorių, bet plikom ESP8266 reikia 3,3V, o WS2812 juostoms reikia 5V arba 12V. Galite naudoti skirtingus ESP ir juostos maitinimo šaltinius, tada sujungiate minusus kartu. Be to, įsitikinkite, kad jūsų šviesos diodams ir ESP yra pakankamai galios, per silpnas maitinimo šaltinis gali sukelti nenumatytą šalutinį poveikį, pvz., atsitiktinį paleidimą iš naujo, netinkamą spalvą ir t. t. ESP plokštei paprastai pakanka 500mA. Kiekvienas WS2812 šviesos diodas sunaudoja iki 60mA.

Kaip kompiliuoti

1. Šiuo metu projektas sukurtas naudojant PlatformIO ir Visual Studio Code.
2. PlatformIO ir Visual Studio Code nustatymas aprašytas čia.
3. Visos bibliotekos priklausomybės yra išvardytos platformio.ini faile ir turėtų būti atsisiunčiamos automatiškai.
4. Būtinai nustatykite plokštės nustatymus platformio.ini faile (bent COM prievadą).
5. Nepamirškite įkelti SPIFFS atvaizdą (paleiskite užduotį "Upload Filesystem Image")

Modulio valdymas

Šiuo metu, kai modulis yra įjungiamas, jis pradeda leisti animacijas atsitiktine tvarka, keičiasi kas 30 sekundžių. Naudodami naršyklę galite rankiniu būdu valdyti animacijas ir paletes, taip pat galite įjungti ir išjungti girliandą. Kol atidarytas pagrindinis sąsajos puslapis, automatinio efektų pakeitimo nėra! Ilgai paspaudę efekto arba paletės mygtuką, galite pašalinti juos iš atsitiktinio pasirinkimo, kai uždaroma žiniatinklio sąsaja. Sąrašo pabaigoje yra specialus efektas "Magija"(Firefox naršyklė), skirtas Kalėdų eglutėms. Pasirinkę, galite valdyti šviesą pakreipdami įrenginį, kuriame atidarytas pagrindinis sąsajos puslapis. Pavyzdys parodytas šiame vaizdo įraše: https://youtu.be/ZXqNeq31DUs. Pakreipiate prietaisą, kad pakeistumėte "taikinio tašką", sukite jį, kad pakeistumėte spalvą, ir pastumkite, kad paryškintumėte. SVARBU: šis efektas nerodomas, jei įrenginio naršyklė neleidžia pasiekti jutiklių (https://w3c.github.io/deviceorientation/#security-and-privacy). Deja, apribojimas taikomas visoms ne HTTPS svetainėms. Kadangi nustatyti tinkamą HTTPS vietiniuose įrenginiuose yra sudėtinga, vienintelis būdas, kurį žinau, kad efektas veiktų, yra naudoti "Chrome" naršyklę, įjungti parinktį --unsafely-treat-insecure-origin-as-secure chrome://flags puslapyje ir šioje parinktyje nurodykite modulio IP adresą.

Valdymas per MQTT

Ryšys su MQTT brokeriu konfigūruojamas per žiniatinklio sąsają. Liana dirba tik kaip MQTT klientė. Komandos siunčiamos paprastu tekstu. Šios komandos pateiktos žemiau. Išraiškos riestiniuose skliaustuose {XXX} turi būti pakeistos atitinkamomis reikšmėmis. Komandų, kuriose yra parametrų, pabaigoje rekomenduojama pridėti tarpą arba CR/LF simbolius.

1. on - įjungti.
2. off - išjungti.
3. palette={paletės numeris} - nustatyti paletę, numeracija prasideda nuo 0.
4. animation={animacijos numeris} - nustatyti animaciją, numeracija prasideda nuo 0.
5. duration={sekundės} - nustato esamo efekto (paletės/animacijos) trukmę, atsitiktinis ciklas prasideda praėjus nurodytam laikui.
6. brightness={ryškumas} - nustato ryškumą (0...255).
7. brightness up - padidina ryškumą.
8. brightness down - sumažina ryškumą.

Проект Liana: световая анимация на ESP8266/WS2812

Как быстро запустить

1. Подключите плату ESP, светодиодную ленту (гирлянду) и источник питания как показано ниже (подключение)
2. Загрузите в ESP файлы: основную прошивку по адресу 0x000000 и файловую систему по адресу 0x100000. Нужно соответствующим образом выставить настройки: номер COM-порта, размер flash-памяти, режим SPI. Я использовал официальный инструмент Flash download tools (скачать можно здесь), и работающие настройки для платы NodeMCU выглядили так:

3. После запуска подключитесь к беспроводной сети под названием "Liana" и нажмите на всплывающую панель с требованием авторизации - откроется web-интерфейс Liana. Если панель не появляется, перейдите по адресу http://192.168.4.1/ в браузере. В интерфейсе можно подключиться к домашней сети WiFi.
4. После подключения Liana к сети WiFi, откройте "http://liana.local" в браузере на устройстве с iOS, MacOS or Windows, находящимися в той же сети. К большому сожалению, это не работает для Android - нужно знать IP-адрес Liana (в админской консоли роутера, посмотрев вывод Liana в COM-порт после старта, либо используя клиент mDNS вроде https://play.google.com/store/apps/details?id=com.dokoden.dotlocalfinder). Потом подключайтесь браузером к "http://<IP_ADDRESS>".

Подключение

В качестве примера показана плата NodeMCU, но можно использовать любую плату с ESP8266. Нужно иметь в виду, что для других плат возможно потребуется перекомпиляция кода! Т.е. достаточно просто подвести питание к плате, ленте/гирлянде светодиодов WS2812, и подключить выход GPIO2 модуля ESP ко входу данных первого WS2812 в цепочке. Будьте внимательны при выборе блока питания - большинство плат с ESP8266 имеют стабилизатор напряжения, но голая ESP8266 требует точно 3,3 В. Ленты/гирлянды WS2812 требуют 5 В или 12В. Можно использовать разные блоки питания для светодиодов и для ESP; в этом случае у них объединяются "земли". Также убедитесь, что блок питания достаточно мощный для светодиодов и модуля ESP. Слишком слабый блок может вызвать нежелательные побочные эффекты вроде спонтанных перезагрузок, искажения цветов и т.п. Модулю ESP обычно хватает 500 мА, каждый светодиод WS2812 может кушать до 60 мА.

Как собрать

1. Сейчас проект собран для PlatformIO (https://platformio.org/) и Visual Studio Code (https://code.visualstudio.com/)
2. Настройки PlatformIO и Visual Studio code хорошо описаны, например, здесь: https://docs.platformio.org/en/latest/integration/ide/vscode.html
3. Все зависимости прописаны в файле platformio.ini и загружаются автоматически.
4. Не забудьте прописать параметры платы ESP в platformio.ini (как минимум номер COM-порта для загрузки)
5. Не забудьте при прошивке также загрузить образ файловой системы (выполнить задачу "Upload Filesystem Image")

Управление модулем

Сейчас после подачи питания модуль начинает проигрывать эффекты в случайном порядке со сменой каждые 30 секунд. В web-интерфейсе можно вручную переключать анимации и палитры, а также включать и выключать ленту. Пока открыта основная страница web-интерфейса, автоматической смены эффектов не происходит! Длительным нажатием на кнопку эффекта или палитры можно исключить их из случайного перебора при закрытом web-интерфейсе. Так можно оставить только понравившиеся эффекты и палитры. В конце списка находится особенный эффект (Магия), разработанный преимущественно для новогодних ёлок. Когда он выбран, можно управлять светом при помощи наклонов устройства, на котором открыт web-интерфейс. Пример показан в этом видео: https://youtu.be/ZXqNeq31DUs. Наклоняйте устройство для смены "целевой точки", поворачивайте его для смены цвета и делайте выпад для подсветки. ВАЖНО: Этот эффект не показывается, если браузер устройства запрещает доступ к датчикам (https://w3c.github.io/deviceorientation/#security-and-privacy). К сожалению это ограничение распространяется на все сайты, работающие не по HTTPS. Т.к. настройка HTTPS в локальной сети ни разу не тривиальная, единственный известный мне способ заставить эффект работать - использовать браузер Chrome, включить опцию --unsafely-treat-insecure-origin-as-secure на странице chrome://flags и указать IP-адрес модуля в этой опции.

Управление по MQTT

Соединение с брокером MQTT настраивается через web-интерфейс. Liana работает только как клиент MQTT. Команды отправляются простым текстом. Ниже перечислены эти команды. Выражения в фигурных скобках {XXX} должны быть заменены на соответствующие значения В конце команд, содержащих параметры, рекомендуется добавлять пробел или символы CR/LF.

1. on - включить
2. off - выключить
3. palette={номер палитры} - выбрать палитру, номера начинаются с 0
4. animation={номер эффекта} - выбрать анимацию, номера начинаются с 0
5. duration={секунды} - устанавливает длительность текущего эффекта; после истечения времени возобновляется случайный перебор
6. brightness={яркость} - устанавливается яркость (0..255)
7. brightness up - увеличивает яркость
8. brightness down - уменьшает яркость

Project Liana: ESP8266/WS2812 LIght ANimation

How to start

1. Connect your ESP, LED strip and power source as shown below (Wiring)
2. Upload binary files: program file at 0x000000, and SPIFFS file at 0x100000. You should adjust settings for your board, particuarly COM port number, flash size, and SPI mode. I used official Flash download tools (can be found here), and my working settings for NodeMCU board looked like this:

1. Connect to "Liana" wireless network and tap on pop-up authorization panel. You'll be brought directly to the Liana web interface. If the panel didn't open, go to http://192.168.4.1/ in the browser. You can configure connection to your WiFi network there.
2. Once you have connected Liana to your WiFi, open "http://liana.local" in web browser of any iOS, MacOS or Windows device on the same network. This does not work for Android however, you should find IP address of the Liana (e.g. in your router admin console, seeing Liana COM port output after startup, or using mDNS client like https://play.google.com/store/apps/details?id=com.dokoden.dotlocalfinder). Then type "http://<IP_ADDRESS>" in Android browser.

Wiring

Here example of NodeMCU is shown, but you can use any ESP8266 board. But note you may have to recompile the code! You power the board, power the WS2812 chain, and connect GPIO2 output of ESP to the data input of the firsh WS2812 in chain, that's all. Be sure you use appropriate power source; most of ESP8266 board have voltage stabilizer but "raw" ESP8266 require 3.3V while WS2812 strips require 5V or 12V. You can use different power sources for ESP and the strip, you connect grounds then. Also, be sure that there's enough power for your LEDs and ESP; too weak power source can cause unintended side effects like random rebooting, wrong coloring etc. 500 mA is typically enough for ESP board. Each WS2812 LED eats up to 60 mA.

How to compile

1. Currently the project is built with PlatformIO (https://platformio.org/) and Visual Studio Code (https://code.visualstudio.com/)
2. Setting up PlatformIO and Visual Studio Code is described here: https://docs.platformio.org/en/latest/integration/ide/vscode.html
3. All library dependencies are enumerated in platformio.ini file and should be downloaded automatically.
4. Be sure to set up your board settings in platformio.ini file (at least COM port for downloading)
5. Don't forget to upload SPIFFS image (Run task "Upload Filesystem Image")

Controlling the unit

Currently, when unit is powered on, it starts to play animations in random order, changing every 30 seconds. With web browser, you can control animations and palettes manually. Also you can switch the strip on and off. While main web page is open, no automatic change occurs. Long tapping on animation or palette disables it (excludes from random enumeration when web interface is closed). There's special animation at the end of the list (called 'Magic'), designed for New Year trees mainly. When it's selected, you can control the lights with your device accelerometer (as shown in this video: https://youtu.be/ZXqNeq31DUs). You tilt the device to alter "target point", roll it to change color and lunge to highlight. IMPORTANT NOTE: the Magic animation is hidden when browser restricts access to mobile device sensors (https://w3c.github.io/deviceorientation/#security-and-privacy). Unfortunately the restriction applies to all non-HTTPS sites. Since setting up proper HTTPS on local devices is cumbersome, the only way I know to make this animation work is using Chrome and enable --unsafely-treat-insecure-origin-as-secure option in chrome://flags and specify your IP address in the option value textbox.

MQTT operation

MQTT broker connection is set up in web interface. Liana works as MQTT client only. Commands are sent in plain text. Below description of commands goes. {XXX} is replaced with actual value of parameter. It's recommended to add a space or CR/LF chars to the end of parametrized commands.

1. on - turn on
2. off - turn off
3. palette={palette index} - set palette, index numbering starts from 0
4. animation={animation index} - set animation, index numbering starts from 0
5. duration={seconds} - sets current effect (palette/animation) duration; random cycling starts after specified time elapses
6. brightness={brightness} - sets brightness (0..255)
7. brightness up - increases brightness (exponential)
8. brightness down - decreases brightness (exponential)