{"id":19517476,"url":"https://github.com/ivkos/luxsrv","last_synced_at":"2025-02-26T00:12:24.805Z","repository":{"id":42951158,"uuid":"233252815","full_name":"ivkos/luxsrv","owner":"ivkos","description":"Listens for network packets controlling RGB LED strips on NodeMCU ESP8266","archived":false,"fork":false,"pushed_at":"2022-03-26T00:55:26.000Z","size":101,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-08T12:44:16.297Z","etag":null,"topics":["esp8266","led","led-strips","lua","network","nodemcu","nodemcu-esp8266","nodemcu-lua","rgb","udp","ws2812b"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ivkos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-11T15:28:05.000Z","updated_at":"2020-07-04T10:18:46.000Z","dependencies_parsed_at":"2022-09-06T20:21:42.878Z","dependency_job_id":null,"html_url":"https://github.com/ivkos/luxsrv","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fluxsrv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fluxsrv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fluxsrv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fluxsrv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivkos","download_url":"https://codeload.github.com/ivkos/luxsrv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240766613,"owners_count":19854119,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp8266","led","led-strips","lua","network","nodemcu","nodemcu-esp8266","nodemcu-lua","rgb","udp","ws2812b"],"created_at":"2024-11-11T00:03:51.020Z","updated_at":"2025-02-26T00:12:24.556Z","avatar_url":"https://github.com/ivkos.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# luxsrv\n❤️💚💙\n\n**luxsrv** is a Lua program for the NodeMCU ESP8266 devkit that listens for \nnetwork packets describing the color setup and driving the WS2812B LED strip.\n\n**luxsrv** is part of **[Lux](https://github.com/ivkos/lux)**.\n\n## NodeMCU\nRefer to these resources for more details:\n* [NodeMCU Overview](https://nodemcu.readthedocs.io/en/master/)\n* [NodeMCU Getting Started](https://nodemcu.readthedocs.io/en/master/getting-started/)\n\n## Firmware\nThe NodeMCU ESP8266 devkit must have the NodeMCU firmware flashed on it. \nRefer to the following resources for instructions how to flash it:\n\n* Building the NodeMCU firmware:\n  - [Reference](https://nodemcu.readthedocs.io/en/master/build/)\n  - [NodeMCU Custom Builds](https://nodemcu-build.com/) - Cloud Build Service\n* Flashing the NodeMCU firmware:\n  - [Reference](https://nodemcu.readthedocs.io/en/master/flash/)\n  - [NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher)\n\n## Development\n\n### Requirements\n* Node.js (required by [NodeMCU-Tool](https://github.com/andidittrich/NodeMCU-Tool))\n\n### Installing\nRun **`npm install`** to install the dependencies.\n\n### Configuration\n#### Wi-Fi Configuration\nWi-Fi credentials must reside in `src/wifi_config.lua` following this format:\n```lua\nreturn {\n    WIFI_SSID = \"My Home Network\",\n    WIFI_PSK = \"MySuperSecretPassword\"\n}\n```\n\n#### LED Pixel Count\nSet the number of pixels on your LED strip in `src/lux_server.lua`, e.g.:\n```lua\nlocal LED_COUNT = 120\nlocal PORT = 42170\n```\n\n### Uploading the Scripts\n- Connect the ESP8266 to your PC via its microUSB port.\n- To list what's on the device, run **`npm run ls`**\n- To format the device, run **`npm run format`**\n- Compile and upload with **`npm run upload`**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivkos%2Fluxsrv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivkos%2Fluxsrv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivkos%2Fluxsrv/lists"}