https://github.com/remcoder/ledcontroller

Firmware for an esp8266 based LED strip controller (ws2812), written in Lua (nodemcu)
https://github.com/remcoder/ledcontroller

Last synced: 12 months ago
JSON representation

Firmware for an esp8266 based LED strip controller (ws2812), written in Lua (nodemcu)

• Host: GitHub
• URL: https://github.com/remcoder/ledcontroller
• Owner: remcoder
• License: mit
• Created: 2016-07-25T20:16:05.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-08-18T20:22:15.000Z (over 9 years ago)
• Last Synced: 2025-01-29T06:32:23.414Z (about 1 year ago)
• Language: Lua
• Size: 250 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Ledcontroller

An esp8266 based controller for ws2812 LED strips, written in Lua.

## Development

### Setup

1 These tools should be installed globally.

Install as follows:

    $ npm install -g gulp

    $ npm install -g nodemcu-tool

    $ pip install nodemcu-uploader

    $ pip install esptool

2 Then install other dependencies locally by running:

    

    $ npm install

### Upload the NodeMCU firmware

Just run:

    $ ./flash.sh

### Upload the files for the LED controller

Just run:

    $ gulp

    

This will copy over all Lua files in src to the esp8266. If you run this command again it will only copy files that have been changed.

### Run a Lua script from the bash prompt

There are two kinds of script that are invocable from the the bash prompt: *commands* and *patterns*. Both are stored in there respective folders.

To run a script inside the 'command' folder, you can run:

    

    $ ./run.sh 

    

To run a script inside the 'pattern' folder, you can run:

    

    $ ./pattern.sh 

### More

Here a few more things you can do:

__Remove *.lc files from the esp8266__ 

      $ ./remove_lc.sh 

      

__Copy over all Lua files in src, changed or not__

      $ gulp all

      

__Reset the synchroniztion cache__

 

Deletes all files in 'dist'.

      $ gulp clean # 

     

__Fast dev cycle__

Does the following 3 things in order:

  1. copy modified files to esp8266

  2. reboot esp3266

  3. open serial connection to esp8266

    $ ./cycle.sh

 

__Lint your code__

Runs luacheck on your Lua files

    $ gulp lint