Skip to main content

FastLED Wasm Compiler

Project description

FastLED wasm compiler

Compiles an Arduino/Platformio sketch into a wasm binary that can be run directly in the web browser.

Linting Build and Push Multi Docker Image MacOS_Tests Ubuntu_Tests Win_Tests

About

This python app will compile your FastLED style sketches into html/js/wasm output that runs directly in the browser.

Compile times are extremely fast - I've seen as low as 5 seconds but 8-15 seconds is typical.

This works on Windows/Linux/Mac(arm/x64).

Docker is required.

https://github.com/user-attachments/assets/64ae0e6c-5f8b-4830-ab87-dcc25bc61218

Demo

https://zackees.github.io/fastled-wasm/

Install

pip install fastled-wasm

Note that you may need to install x86 docker emulation on Mac-m1 and later, as this is an x86 only image at the prsent.

Use

Change to the directory where the sketch lives and run

cd <SKETCH-DIRECTORY>
fastled-wasm

Or if you don't have docker then use our web compiler

cd <SKETCH-DIRECTORY>
fastled-wasm --web

After compilation a web browser windows will pop up.

Hot reload by default

Once launched, the compiler will remain open, listening to changes and recompiling as necessary and hot-reloading the sketch into the current browser.

This style of development should be familiar to those doing web development.

Data

If you want to embed data, then do so in the data/ directory at the project root. The files will appear in the data/ director of any spawned FileSystem or SDCard.

About the compilation.

Pre-processing is done to your source files. A fake Arduino.h will be inserted into your source files that will provide shims for most of the common api points.

Revisions

  • 1.1.8 - Program now knows it's own version which will be displayed with help file. Use --version to get it directly.
  • 1.1.7 - Sketch cache re-enabled, but selectively invalidated on cpp/h updates. Cleaned up deprecated args. Fixed double thread running for containers that was causing slowdown.
  • 1.1.6 - Use the fast src volume map allow quick updates to fastled when developing on the source code.
  • 1.1.5 - Filter out hidden files and directories from being included in the sketch archive sent to the compiler.
  • 1.1.4 - Fix regression introduced by testing out ipv4/ipv6 connections from a thread pool.
  • 1.1.3 - Live editing of *.h and *.cpp files is now possible. Sketch cache will be disabled in this mode.
  • 1.1.2 - --server will now volume map fastled src directory if it detects this. This was also implemented on the docker side.
  • 1.1.1 - --interactive is now supported to debug the container. Volume maps and better compatibilty with ipv4/v6 by concurrent connection finding.
  • 1.1.0 - Use fastled as the command for the wasm compiler.
  • 1.0.17 - Pulls updates when necessary. Removed dependency on keyring.
  • 1.0.16 - fastled-wasm package name has been changed to fled
  • 1.0.15 - fled is an alias of fastled-wasm and will eventually replace it. --web-host was folded into --web, which if unspecified will attempt to run a local docker server and fallback to the cloud server if that fails. Specifying --web with no arguments will default to the cloud server while an argument (like localhost) will cause it to bind to that already running server for compilation.
  • 1.0.14 - For non significant changes (comments, whitespace) in C++/ino/*.h files, compilation is skipped. This significantly reduces load on the server and prevents unnecessary local client browser refreshes.
  • 1.0.13 - Increase speed of local compiles by running the server version of the compiler so it can keep it's cache and not have to pay docker startup costs because now it's a persistant server until exit.
  • 1.0.12 - Added suppport for compile modes. Pass in --release, --quick, --debug for different compile options. We also support --profile to profile the build process.
  • 1.0.11 - --web compile will automatically be enabled if the local build using docker fails.
  • 1.0.10 - Watching files is now available for --web
  • 1.0.9 - Enabled web compile. Access it with --web or --web-host
  • 1.0.8 - Allow more than one fastled-wasm browser instances to co-exist by searching for unused ports after 8081.
  • 1.0.7 - Docker multi image build implemented, tool now points to new docker image compile.
  • 1.0.6 - Removed --no-open and --watch, --watch is now assumed unless --just-compile is used.
  • 1.0.5 - Implemented --update to update the compiler image from the docker registry.
  • 1.0.4 - Implemented --watch which will watch for changes and then re-launch the compilation step.
  • 1.0.3 - Integrated live-server to launch when available.
  • 1.0.2 - Small bug with new installs.
  • 1.0.1 - Re-use is no longer the default, due to problems.
  • 1.0.0 - Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fastled-1.0.8.tar.gz (160.3 kB view details)

Uploaded Source

Built Distribution

fastled-1.0.8-py2.py3-none-any.whl (21.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fastled-1.0.8.tar.gz.

File metadata

  • Download URL: fastled-1.0.8.tar.gz
  • Upload date:
  • Size: 160.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for fastled-1.0.8.tar.gz
Algorithm Hash digest
SHA256 011e9d0db51ee734a85ca174ac4910e9ace90631283e208d1f9ce6e1691db8d2
MD5 32cb4e281c795f72882aef7c677adce1
BLAKE2b-256 93c7ea7c30b7fc3f11d967cbf85ffb9895fd30b70da3a687a6887e8ca25ce981

See more details on using hashes here.

File details

Details for the file fastled-1.0.8-py2.py3-none-any.whl.

File metadata

  • Download URL: fastled-1.0.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for fastled-1.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4830aa3a1c7d0c2ecb79d4bcf14c6c979c520bbbd9f73ce038809912964e4563
MD5 c7d9fd3fc1f318f5a4a116a9d8fedc17
BLAKE2b-256 946e3c5fb7fda55772367cfb7f64ed8dcb1b8ae5f11213310c3d607f061341e2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page