fastled 1.1.35__tar.gz → 1.1.37__tar.gz

{fastled-1.1.35 → fastled-1.1.37}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fastled
-Version: 1.1.35
+Version: 1.1.37
 Summary: FastLED Wasm Compiler
 Home-page: https://github.com/zackees/fastled-wasm
 Maintainer: Zachary Vorhies
@@ -163,6 +163,8 @@ A: A big chunk of space is being used by unnecessary javascript `emscripten` is
 
 # Revisions
   
+  * 1.1.37 - `Test.test_examples()` is now unit tested to work correctly.
+  * 1.1.36 - We now have an api. `from fastled import Api` and `from fastled import Test` for testing.
   * 1.1.35 - When searching for files cap the limit at a high amount to prevent hang.
   * 1.1.34 - On windows check to make sure we are in linux container mode, if not try to switch and if that fails then use `--web` compiler.
   * 1.1.33 - Auto updating frequency has been reduced from one hour to one day. To update immediatly use `--update`.

{fastled-1.1.35 → fastled-1.1.37}/README.md

@@ -140,6 +140,8 @@ A: A big chunk of space is being used by unnecessary javascript `emscripten` is
 
 # Revisions
   
+  * 1.1.37 - `Test.test_examples()` is now unit tested to work correctly.
+  * 1.1.36 - We now have an api. `from fastled import Api` and `from fastled import Test` for testing.
   * 1.1.35 - When searching for files cap the limit at a high amount to prevent hang.
   * 1.1.34 - On windows check to make sure we are in linux container mode, if not try to switch and if that fails then use `--web` compiler.
   * 1.1.33 - Auto updating frequency has been reduced from one hour to one day. To update immediatly use `--update`.

{fastled-1.1.35 → fastled-1.1.37}/examples/Chromancer/Chromancer.ino

@@ -15,14 +15,14 @@
 #include "ripple.h"
 #include <FastLED.h>
 #include "detail.h"
-#include "screenmap.h"
-#include "math_macros.h"
-#include "json.h"
+#include "fl/screenmap.h"
+#include "fl/math_macros.h"
+#include "fl/json.h"
 #include "fl/ui.h"
-#include "fixed_map.h"
+#include "fl/map.h"
 
 #include "screenmap.json.h"
-#include "str.h"
+#include "fl/str.h"
 
 enum {
     BlackStrip = 0,

{fastled-1.1.35 → fastled-1.1.37}/examples/Video/Gfx2Video/Gfx2Video.ino

@@ -1,90 +1,90 @@
-/// @file    Frame2Video.ino
-/// @brief   Demonstrates drawing to a frame buffer, which is used as source video for the memory player.
-///          The render pattern is alternating black/red pixels as a checkerboard.
-/// @example VideoTest.ino
-
-
-#ifndef COMPILE_VIDEO_STREAM
-#if defined(__AVR__)
-// This has grown too large for the AVR to handle.
-#define COMPILE_VIDEO_STREAM 0
-#else
-#define COMPILE_VIDEO_STREAM 1
-#endif
-#endif // COMPILE_VIDEO_STREAM
-
-#if COMPILE_VIDEO_STREAM
-
-
-#include <FastLED.h>
-#include "fx/storage/bytestreammemory.h"
-#include "fx/2d/video.hpp"
-#include "fx/fx_engine.h"
-#include "ref.h"
-#include "fx/video.h"
-
-#define LED_PIN 2
-#define BRIGHTNESS 96
-#define LED_TYPE WS2811
-#define COLOR_ORDER GRB
-
-#define MATRIX_WIDTH 22
-#define MATRIX_HEIGHT 22
-#define NUM_LEDS (MATRIX_WIDTH * MATRIX_HEIGHT)
-
-CRGB leds[NUM_LEDS];
-
-const int BYTES_PER_FRAME = 3 * NUM_LEDS;
-const int NUM_FRAMES = 2;
-const uint32_t BUFFER_SIZE = BYTES_PER_FRAME * NUM_FRAMES;
-
-ByteStreamMemoryRef memoryStream;
-FxEngine fxEngine(NUM_LEDS);
-// Create and initialize Video fx object
-XYMap xymap(MATRIX_WIDTH, MATRIX_HEIGHT);
-
-void write_one_frame(ByteStreamMemoryRef memoryStream) {
-    //memoryStream->seek(0);  // Reset to the beginning of the stream
-    uint32_t total_bytes_written = 0;
-    int toggle = (millis() / 500) % 2;
-    for (uint32_t i = 0; i < NUM_LEDS; ++i) {
-        CRGB color = (i % 2 == toggle) ? CRGB::Black : CRGB::Red;
-        size_t bytes_written = memoryStream->write(color.raw, 3);
-        if (bytes_written != 3) {
-        }
-        total_bytes_written += bytes_written;
-    }
-}
-
-void setup() {
-    delay(1000); // sanity delay
-    FastLED.addLeds<LED_TYPE, LED_PIN, COLOR_ORDER>(leds, NUM_LEDS)
-        .setCorrection(TypicalLEDStrip)
-        .setScreenMap(xymap);
-    FastLED.setBrightness(BRIGHTNESS);
-
-    // Create and fill the ByteStreamMemory with test data
-    memoryStream = ByteStreamMemoryRef::New(BUFFER_SIZE);
-    write_one_frame(memoryStream);  // Write initial frame data
-    Video video(memoryStream, NUM_LEDS, 30.0f, 0);
-    // Add the video effect to the FxEngine
-    fxEngine.addVideo(video, xymap);
-}
-
-void loop() {
-    // Reset the memory stream position before reading
-    //memoryStream->seek(0);
-    write_one_frame(memoryStream);  // Write next frame data
-
-    // Draw the frame
-    fxEngine.draw(millis(), leds);
-
-    // Show the LEDs
-    FastLED.show();
-
-    delay(100); // Adjust this delay to control frame rate
-}
-#else
-void setup() {}
-void loop() {}
-#endif // COMPILE_VIDEO_STREAM
+/// @file    Frame2Video.ino
+/// @brief   Demonstrates drawing to a frame buffer, which is used as source video for the memory player.
+///          The render pattern is alternating black/red pixels as a checkerboard.
+/// @example VideoTest.ino
+
+
+#ifndef COMPILE_VIDEO_STREAM
+#if defined(__AVR__)
+// This has grown too large for the AVR to handle.
+#define COMPILE_VIDEO_STREAM 0
+#else
+#define COMPILE_VIDEO_STREAM 1
+#endif
+#endif // COMPILE_VIDEO_STREAM
+
+#if COMPILE_VIDEO_STREAM
+
+
+#include <FastLED.h>
+#include "fx/storage/bytestreammemory.h"
+#include "fx/2d/video.hpp"
+#include "fx/fx_engine.h"
+#include "ref.h"
+#include "fx/video.h"
+
+#define LED_PIN 2
+#define BRIGHTNESS 96
+#define LED_TYPE WS2811
+#define COLOR_ORDER GRB
+
+#define MATRIX_WIDTH 22
+#define MATRIX_HEIGHT 22
+#define NUM_LEDS (MATRIX_WIDTH * MATRIX_HEIGHT)
+
+CRGB leds[NUM_LEDS];
+
+const int BYTES_PER_FRAME = 3 * NUM_LEDS;
+const int NUM_FRAMES = 2;
+const uint32_t BUFFER_SIZE = BYTES_PER_FRAME * NUM_FRAMES;
+
+ByteStreamMemoryRef memoryStream;
+FxEngine fxEngine(NUM_LEDS);
+// Create and initialize Video fx object
+XYMap xymap(MATRIX_WIDTH, MATRIX_HEIGHT);
+
+void write_one_frame(ByteStreamMemoryRef memoryStream) {
+    //memoryStream->seek(0);  // Reset to the beginning of the stream
+    uint32_t total_bytes_written = 0;
+    int toggle = (millis() / 500) % 2;
+    for (uint32_t i = 0; i < NUM_LEDS; ++i) {
+        CRGB color = (i % 2 == toggle) ? CRGB::Black : CRGB::Red;
+        size_t bytes_written = memoryStream->write(color.raw, 3);
+        if (bytes_written != 3) {
+        }
+        total_bytes_written += bytes_written;
+    }
+}
+
+void setup() {
+    delay(1000); // sanity delay
+    FastLED.addLeds<LED_TYPE, LED_PIN, COLOR_ORDER>(leds, NUM_LEDS)
+        .setCorrection(TypicalLEDStrip)
+        .setScreenMap(xymap);
+    FastLED.setBrightness(BRIGHTNESS);
+
+    // Create and fill the ByteStreamMemory with test data
+    memoryStream = ByteStreamMemoryRef::New(BUFFER_SIZE);
+    write_one_frame(memoryStream);  // Write initial frame data
+    Video video(memoryStream, NUM_LEDS, 30.0f, 0);
+    // Add the video effect to the FxEngine
+    fxEngine.addVideo(video, xymap);
+}
+
+void loop() {
+    // Reset the memory stream position before reading
+    //memoryStream->seek(0);
+    write_one_frame(memoryStream);  // Write next frame data
+
+    // Draw the frame
+    fxEngine.draw(millis(), leds);
+
+    // Show the LEDs
+    FastLED.show();
+
+    delay(100); // Adjust this delay to control frame rate
+}
+#else
+void setup() {}
+void loop() {}
+#endif // COMPILE_VIDEO_STREAM

fastled-1.1.37/src/fastled/__init__.py

@@ -0,0 +1,94 @@
+"""FastLED Wasm Compiler package."""
+
+# context
+from contextlib import contextmanager
+from pathlib import Path
+
+from .compile_server import CompileServer
+from .types import WebCompileResult
+
+__version__ = "1.1.37"
+
+
+class Api:
+    @staticmethod
+    def get_examples():
+        from fastled.project_init import get_examples
+
+        return get_examples()
+
+    @staticmethod
+    def project_init(
+        example=None, outputdir=None, host: str | CompileServer | None = None
+    ) -> Path:
+        from fastled.project_init import project_init
+
+        if isinstance(host, CompileServer):
+            host = host.url()
+        return project_init(example, outputdir, host)
+
+    @staticmethod
+    def web_compile(
+        directory: Path | str, host: str | CompileServer | None = None
+    ) -> WebCompileResult:
+        from fastled.web_compile import web_compile
+
+        if isinstance(host, CompileServer):
+            host = host.url()
+        if isinstance(directory, str):
+            directory = Path(directory)
+        out: WebCompileResult = web_compile(directory, host)
+        return out
+
+    @staticmethod
+    def spawn_server(
+        sketch_directory: Path | None = None,
+        interactive=False,
+        auto_updates=None,
+        auto_start=True,
+        container_name: str | None = None,
+    ):
+        from fastled.compile_server import CompileServer
+
+        out = CompileServer(
+            container_name=container_name,
+            interactive=interactive,
+            auto_updates=auto_updates,
+            mapped_dir=sketch_directory,
+            auto_start=auto_start,
+        )
+        return out
+
+    @staticmethod
+    @contextmanager
+    def server(
+        sketch_directory: Path | None = None,
+        interactive=False,
+        auto_updates=None,
+        auto_start=True,
+        container_name: str | None = None,
+    ):
+        server = Api.spawn_server(
+            sketch_directory=sketch_directory,
+            interactive=interactive,
+            auto_updates=auto_updates,
+            auto_start=auto_start,
+            container_name=container_name,
+        )
+        try:
+            yield server
+        finally:
+            server.stop()
+
+
+class Test:
+    @staticmethod
+    def test_examples(
+        examples: list[str] | None = None, host: str | CompileServer | None = None
+    ) -> dict[str, Exception]:
+        from fastled.test.examples import test_examples
+
+        if isinstance(host, CompileServer):
+            host = host.url()
+
+        return test_examples(examples=examples, host=host)

{fastled-1.1.35 → fastled-1.1.37}/src/fastled/app.py

@@ -17,14 +17,17 @@ def run_server(args: argparse.Namespace) -> int:
     auto_update = args.auto_update
     mapped_dir = Path(args.directory).absolute() if args.directory else None
     compile_server = CompileServer(
-        interactive=interactive, auto_updates=auto_update, mapped_dir=mapped_dir
+        interactive=interactive,
+        auto_updates=auto_update,
+        mapped_dir=mapped_dir,
+        auto_start=True,
     )
+
     if not interactive:
         print(f"Server started at {compile_server.url()}")
-        compile_server.wait_for_startup()
     try:
         while True:
-            if not compile_server.proceess_running():
+            if not compile_server.process_running():
                 print("Server process is not running. Exiting...")
                 return 1
             time.sleep(0.1)

{fastled-1.1.35 → fastled-1.1.37}/src/fastled/client_server.py

@@ -8,10 +8,10 @@ from pathlib import Path
 from fastled.build_mode import BuildMode, get_build_mode
 from fastled.compile_server import CompileServer
 from fastled.docker_manager import DockerManager
-from fastled.env import DEFAULT_URL
 from fastled.filewatcher import FileWatcherProcess
 from fastled.keyboard import SpaceBarWatcher
 from fastled.open_browser import open_browser_process
+from fastled.settings import DEFAULT_URL
 from fastled.sketch import looks_like_sketch_directory
 
 # CompiledResult
@@ -112,7 +112,7 @@ def _try_start_server_or_get_url(args: argparse.Namespace) -> str | CompileServe
             print("No local server found, starting one...")
             compile_server = CompileServer(auto_updates=auto_update)
             print("Waiting for the local compiler to start...")
-            if not compile_server.wait_for_startup():
+            if not compile_server.ping():
                 print("Failed to start local compiler.")
                 raise RuntimeError("Failed to start local compiler.")
             return compile_server
@@ -254,7 +254,7 @@ def run_client_server(args: argparse.Namespace) -> int:
             if changed:
                 print_status()
                 continue
-            if compile_server and not compile_server.proceess_running():
+            if compile_server and not compile_server.process_running():
                 print("Server process is not running. Exiting...")
                 return 1
             if source_code_watcher is not None:

fastled-1.1.37/src/fastled/compile_server.py

@@ -0,0 +1,82 @@
+from pathlib import Path
+
+from fastled.build_mode import BuildMode
+from fastled.types import WebCompileResult
+
+
+class CompileServer:
+    def __init__(
+        self,
+        interactive: bool = False,
+        auto_updates: bool | None = None,
+        mapped_dir: Path | None = None,
+        auto_start: bool = True,
+        container_name: str | None = None,
+    ) -> None:
+        from fastled.compile_server_impl import (  # avoid circular import
+            CompileServerImpl,
+        )
+
+        self.impl = CompileServerImpl(
+            container_name=container_name,
+            interactive=interactive,
+            auto_updates=auto_updates,
+            mapped_dir=mapped_dir,
+            auto_start=auto_start,
+        )
+
+    def start(self, wait_for_startup=True) -> None:
+        # from fastled.compile_server_impl import CompileServerImpl  # avoid circular import
+        self.impl.start(wait_for_startup=wait_for_startup)
+
+    def web_compile(
+        self,
+        directory: Path | str,
+        build_mode: BuildMode = BuildMode.QUICK,
+        profile: bool = False,
+    ) -> WebCompileResult:
+        return self.impl.web_compile(
+            directory=directory, build_mode=build_mode, profile=profile
+        )
+
+    def project_init(
+        self, example: str | None = None, outputdir: Path | None = None
+    ) -> None:
+        from fastled.project_init import project_init  # avoid circular import
+
+        project_init(example=example, outputdir=outputdir)
+
+    @property
+    def running(self) -> bool:
+        return self.impl.running
+
+    @property
+    def fastled_src_dir(self) -> Path | None:
+        return self.impl.fastled_src_dir
+
+    def using_fastled_src_dir_volume(self) -> bool:
+        return self.impl.using_fastled_src_dir_volume()
+
+    def port(self) -> int:
+        return self.impl.port()
+
+    def url(self) -> str:
+        return self.impl.url()
+
+    def ping(self) -> bool:
+        return self.impl.ping()
+
+    # by default this is automatically called by the constructor, unless
+    # auto_start is set to False.
+    def wait_for_startup(self, timeout: int = 100) -> bool:
+        """Wait for the server to start up."""
+        return self.impl.wait_for_startup(timeout=timeout)
+
+    def _start(self) -> int:
+        return self.impl._start()
+
+    def stop(self) -> None:
+        return self.impl.stop()
+
+    def process_running(self) -> bool:
+        return self.impl.process_running()

fastled-1.1.35/src/fastled/compile_server.py → fastled-1.1.37/src/fastled/compile_server_impl.py

@@ -1,34 +1,39 @@
 import subprocess
 import time
+import warnings
 from datetime import datetime, timezone
 from pathlib import Path
 
 import httpx
 
+from fastled.build_mode import BuildMode
 from fastled.docker_manager import (
     DISK_CACHE,
     Container,
     DockerManager,
     RunningContainer,
 )
+from fastled.settings import SERVER_PORT
 from fastled.sketch import looks_like_fastled_repo
+from fastled.types import WebCompileResult
 
 _IMAGE_NAME = "niteris/fastled-wasm"
 _DEFAULT_CONTAINER_NAME = "fastled-wasm-compiler"
 
-SERVER_PORT = 9021
 
 SERVER_OPTIONS = ["--allow-shutdown", "--no-auto-update"]
 
 
-class CompileServer:
+class CompileServerImpl:
     def __init__(
         self,
-        container_name=_DEFAULT_CONTAINER_NAME,
         interactive: bool = False,
         auto_updates: bool | None = None,
         mapped_dir: Path | None = None,
+        auto_start: bool = True,
+        container_name: str | None = None,
     ) -> None:
+        container_name = container_name or _DEFAULT_CONTAINER_NAME
         if interactive and not mapped_dir:
             raise ValueError(
                 "Interactive mode requires a mapped directory point to a sketch"
@@ -50,13 +55,47 @@ class CompileServer:
         self.interactive = interactive
         self.running_container: RunningContainer | None = None
         self.auto_updates = auto_updates
-        self._port = self._start()
+        # self._port = self._start()
+        self._port = 0  # 0 until compile server is started
         # fancy print
         if not interactive:
             msg = f"# FastLED Compile Server started at {self.url()} #"
             print("\n" + "#" * len(msg))
             print(msg)
             print("#" * len(msg) + "\n")
+        if auto_start:
+            self.start()
+
+    def start(self, wait_for_startup=True) -> None:
+        if self._port != 0:
+            warnings.warn("Server has already been started")
+        self._port = self._start()
+        if wait_for_startup:
+            self.wait_for_startup()
+
+    def web_compile(
+        self,
+        directory: Path | str,
+        build_mode: BuildMode = BuildMode.QUICK,
+        profile: bool = False,
+    ) -> WebCompileResult:
+        from fastled.web_compile import web_compile  # avoid circular import
+
+        if not self._port:
+            raise RuntimeError("Server has not been started yet")
+        if not self.ping():
+            raise RuntimeError("Server is not running")
+        out: WebCompileResult = web_compile(
+            directory, host=self.url(), build_mode=build_mode, profile=profile
+        )
+        return out
+
+    def project_init(
+        self, example: str | None = None, outputdir: Path | None = None
+    ) -> None:
+        from fastled.project_init import project_init  # avoid circular import
+
+        project_init(example=example, outputdir=outputdir)
 
     @property
     def running(self) -> bool:
@@ -72,11 +111,30 @@ class CompileServer:
         return self.fastled_src_dir is not None
 
     def port(self) -> int:
+        if self._port == 0:
+            warnings.warn("Server has not been started yet")
         return self._port
 
     def url(self) -> str:
+        if self._port == 0:
+            warnings.warn("Server has not been started yet")
         return f"http://localhost:{self._port}"
 
+    def ping(self) -> bool:
+        try:
+            response = httpx.get(
+                f"http://localhost:{self._port}", follow_redirects=True
+            )
+            if response.status_code < 400:
+                return True
+        except KeyboardInterrupt:
+            raise
+        except Exception:
+            pass
+        return False
+
+    # by default this is automatically called by the constructor, unless
+    # auto_start is set to False.
     def wait_for_startup(self, timeout: int = 100) -> bool:
         """Wait for the server to start up."""
         start_time = time.time()
@@ -86,16 +144,8 @@ class CompileServer:
                 return False
             # use httpx to ping the server
             # if successful, return True
-            try:
-                response = httpx.get(
-                    f"http://localhost:{self._port}", follow_redirects=True
-                )
-                if response.status_code < 400:
-                    return True
-            except KeyboardInterrupt:
-                raise
-            except Exception:
-                pass
+            if self.ping():
+                return True
             time.sleep(0.1)
             if not self.docker.is_container_running(self.container_name):
                 return False
@@ -182,12 +232,13 @@ class CompileServer:
             print("Exiting interactive mode")
             return port
 
-    def proceess_running(self) -> bool:
+    def process_running(self) -> bool:
         return self.docker.is_container_running(self.container_name)
 
     def stop(self) -> None:
-        # print(f"Stopping server on port {self._port}")
         if self.running_container:
-            self.running_container.stop()
+            self.running_container.detach()
+            self.running_container = None
         self.docker.suspend_container(self.container_name)
+        self._port = 0
         print("Compile server stopped")

{fastled-1.1.35 → fastled-1.1.37}/src/fastled/docker_manager.py

@@ -89,7 +89,7 @@ class RunningContainer:
                 print(f"Error monitoring logs: {e}")
                 break
 
-    def stop(self) -> None:
+    def detach(self) -> None:
         """Stop monitoring the container logs"""
         self.running = False
         self.thread.join()

{fastled-1.1.35 → fastled-1.1.37}/src/fastled/parse_args.py

@@ -5,9 +5,9 @@ from pathlib import Path
 
 from fastled import __version__
 from fastled.docker_manager import DockerManager
-from fastled.env import DEFAULT_URL
 from fastled.project_init import project_init
 from fastled.select_sketch_directory import select_sketch_directory
+from fastled.settings import DEFAULT_URL
 from fastled.sketch import (
     find_sketch_directories,
     looks_like_fastled_repo,

{fastled-1.1.35 → fastled-1.1.37}/src/fastled/project_init.py

@@ -3,7 +3,7 @@ from pathlib import Path
 
 import httpx
 
-from fastled.env import DEFAULT_URL
+from fastled.settings import DEFAULT_URL
 
 ENDPOINT_PROJECT_INIT = f"{DEFAULT_URL}/project/init"
 ENDPOINT_INFO = f"{DEFAULT_URL}/info"
@@ -33,13 +33,17 @@ def _prompt_for_example() -> str:
             return answer
 
 
-def project_init(example: str | None = None, outputdir: Path | None = None) -> Path:
+def project_init(
+    example: str | None = "PROMPT",  # prompt for example
+    outputdir: Path | None = None,
+    host: str | None = None,
+) -> Path:
     """
     Initialize a new FastLED project.
     """
-
-    outputdir = outputdir or Path("fastled")
-    if example is None:
+    host = host or DEFAULT_URL
+    outputdir = Path(outputdir) if outputdir is not None else Path("fastled")
+    if example == "PROMPT" or example is None:
         try:
             example = _prompt_for_example()
         except httpx.HTTPStatusError:
@@ -48,7 +52,8 @@ def project_init(example: str | None = None, outputdir: Path | None = None) -> P
             )
             example = DEFAULT_EXAMPLE
     assert example is not None
-    response = httpx.get(f"{ENDPOINT_PROJECT_INIT}/{example}", timeout=20)
+    endpoint_url = f"{host}/project/init/{example}"
+    response = httpx.get(endpoint_url, timeout=20)
     response.raise_for_status()
     content = response.content
     tmpzip = outputdir / "fastled.zip"

fastled-1.1.35/src/fastled/env.py → fastled-1.1.37/src/fastled/settings.py

@@ -6,3 +6,4 @@ IS_ARM: bool = "arm" in MACHINE or "aarch64" in MACHINE
 PLATFORM_TAG: str = "-arm64" if IS_ARM else ""
 CONTAINER_NAME = f"fastled-wasm-compiler{PLATFORM_TAG}"
 DEFAULT_URL = str(os.environ.get("FASTLED_URL", "https://fastled.onrender.com"))
+SERVER_PORT = 9021