lifx-emulator 2.3.1__py3-none-any.whl → 3.0.1__py3-none-any.whl

lifx_emulator-3.0.1.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: lifx-emulator
+Version: 3.0.1
+Summary: Standalone LIFX Emulator with CLI and HTTP management API
+Author-email: Avi Miller <me@dje.li>
+Maintainer-email: Avi Miller <me@dje.li>
+License-Expression: UPL-1.0
+Classifier: Environment :: Console
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: FastAPI
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: cyclopts>=4.2.0
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: lifx-emulator-core>=2.4.0
+Requires-Dist: rich>=14.2.0
+Requires-Dist: uvicorn>=0.34.0
+Description-Content-Type: text/markdown
+
+# lifx-emulator
+
+Standalone LIFX device emulator with CLI and HTTP management API.
+
+This package provides a ready-to-run emulator for testing LIFX LAN protocol libraries. It includes a command-line interface and an optional HTTP API for runtime device management.
+
+## Installation
+
+```bash
+pip install lifx-emulator
+```
+
+## Quick Start
+
+```bash
+# Start with default configuration (1 color light)
+lifx-emulator
+
+# Create multiple device types
+lifx-emulator --color 2 --multizone 1 --tile 1
+
+# Enable HTTP management API
+lifx-emulator --api
+
+# List available LIFX products
+lifx-emulator list-products
+
+# Create devices by product ID
+lifx-emulator --product 27 --product 38 --product 55
+```
+
+## Features
+
+- Command-line interface for quick emulator setup
+- HTTP management API with web dashboard
+- Real-time device monitoring and management
+- Support for all LIFX device types (color, multizone, tile, infrared, HEV, switch)
+- Persistent device state across restarts
+- Testing scenarios for protocol edge cases
+
+## HTTP Management API
+
+Enable with `--api` to get:
+
+- **Web Dashboard**: `http://localhost:8080` - Real-time monitoring UI
+- **REST API**: Device management, statistics, and scenario control
+- **OpenAPI Docs**: `http://localhost:8080/docs` - Interactive API documentation
+
+```bash
+# Start with API server
+lifx-emulator --color 2 --api --api-port 9090
+
+# Add a device via API
+curl -X POST http://localhost:9090/api/devices \
+  -H "Content-Type: application/json" \
+  -d '{"product_id": 27}'
+```
+
+## Documentation
+
+Full documentation is available at: **https://djelibeybi.github.io/lifx-emulator**
+
+- [Installation Guide](https://djelibeybi.github.io/lifx-emulator/getting-started/installation/)
+- [CLI Reference](https://djelibeybi.github.io/lifx-emulator/cli/cli-reference/)
+- [Web Interface](https://djelibeybi.github.io/lifx-emulator/cli/web-interface/)
+- [REST API](https://djelibeybi.github.io/lifx-emulator/cli/device-management-api/)
+
+## Related Packages
+
+- **[lifx-emulator-core](https://pypi.org/project/lifx-emulator-core/)**: Core library for embedding the emulator in your own projects
+
+## License
+
+[UPL-1.0](https://opensource.org/licenses/UPL)

lifx_emulator-3.0.1.dist-info/RECORD

@@ -0,0 +1,18 @@
+lifx_emulator_app/__init__.py,sha256=AJahGiWKb8U8yLQbJX21takbf-SoxDxMOGxjJeM7M5c,222
+lifx_emulator_app/__main__.py,sha256=f_VwgZfwOdp3zQshv8JQqBX7gocE9ATZbZ3wQndlBvo,22060
+lifx_emulator_app/api/__init__.py,sha256=bpdhugx7PAop5IQhkKnWE-a1hfI9gJoJiNRG2CCWe5A,651
+lifx_emulator_app/api/app.py,sha256=_bltPTPyw9mmPVAPHm9sJytzsovq5bgE8-CDRulnWYQ,4892
+lifx_emulator_app/api/models.py,sha256=fiX9hDmR1C12tzet-kGPmbaG_qiZfiprgy-uxwIcEsE,3970
+lifx_emulator_app/api/mappers/__init__.py,sha256=-lGAg-s16eTMl2_D-3bPu-EMqD2kaPzXHqSrKCnmW2w,156
+lifx_emulator_app/api/mappers/device_mapper.py,sha256=WAo-_PJ2kX3J4GUW_Sjoype1d_uaIh-PtXPfMUAujUY,4155
+lifx_emulator_app/api/routers/__init__.py,sha256=TKPypociZ_uo2YCyW5zIeUfalUh_PkzCVt31MHg9ZPc,381
+lifx_emulator_app/api/routers/devices.py,sha256=5_0Id09Z6yOB3s-uAEAU4oNribV49IitC0-_Bmx3bCk,4218
+lifx_emulator_app/api/routers/monitoring.py,sha256=i82_s61caYd9UvMb4MqWPLP7LuFh5KN8Qkw4_dZr3O0,1460
+lifx_emulator_app/api/routers/scenarios.py,sha256=pWXTliY9MIk-DCxDOZ1cjeAFgHn79ExvY-6lj-yHPWk,9747
+lifx_emulator_app/api/services/__init__.py,sha256=cdKZItYE-KkMX44V9xJW_PHHnJoAw5I7Uw1a1YKHgMI,285
+lifx_emulator_app/api/services/device_service.py,sha256=A2rCuZ1aAJ1tThKM6BYorKAjlaDgDaFCT5C9KUHfAvc,6303
+lifx_emulator_app/api/templates/dashboard.html,sha256=h-PeOH_La5bVOUBcXmTY2leRlMdL8D8yJ-NCx3S16-A,33792
+lifx_emulator-3.0.1.dist-info/METADATA,sha256=SHfU2nVUc6ihUB8AYOjmMUG0YhVmJkzZILVKFeDMED8,3174
+lifx_emulator-3.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+lifx_emulator-3.0.1.dist-info/entry_points.txt,sha256=tNZHeJTPUXNxu_nuk99ArXLKgwYLhIVVxN7YiaiXBOA,66
+lifx_emulator-3.0.1.dist-info/RECORD,,

lifx_emulator-3.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+lifx-emulator = lifx_emulator_app.__main__:main

lifx_emulator_app/__init__.py

@@ -0,0 +1,10 @@
+"""LIFX Emulator Application
+
+Standalone CLI and HTTP management API for the LIFX Emulator.
+"""
+
+from importlib.metadata import version as get_version
+
+__version__ = get_version("lifx-emulator")
+
+__all__ = ["__version__"]

{lifx_emulator → lifx_emulator_app}/__main__.py

@@ -6,8 +6,6 @@ import signal
 from typing import Annotated
 
 import cyclopts
-from rich.logging import RichHandler
-
 from lifx_emulator.constants import LIFX_UDP_PORT
 from lifx_emulator.devices import (
     DEFAULT_STORAGE_DIR,
@@ -21,12 +19,14 @@ from lifx_emulator.factories import (
     create_hev_light,
     create_infrared_light,
     create_multizone_light,
+    create_switch,
     create_tile_device,
 )
 from lifx_emulator.products.registry import get_registry
 from lifx_emulator.repositories import DeviceRepository
 from lifx_emulator.scenarios import ScenarioPersistenceAsyncFile
 from lifx_emulator.server import EmulatedLifxServer
+from rich.logging import RichHandler
 
 app = cyclopts.App(
     name="lifx-emulator",
@@ -239,6 +239,7 @@ async def run(
     hev: Annotated[int, cyclopts.Parameter(group=device_group)] = 0,
     multizone: Annotated[int, cyclopts.Parameter(group=device_group)] = 0,
     tile: Annotated[int, cyclopts.Parameter(group=device_group)] = 0,
+    switch: Annotated[int, cyclopts.Parameter(group=device_group)] = 0,
     # Multizone Options
     multizone_zones: Annotated[
         int | None, cyclopts.Parameter(group=multizone_group)
@@ -284,6 +285,7 @@ async def run(
         multizone_extended: Enable extended multizone support (Beam).
             Set --no-multizone-extended for basic multizone (Z) devices.
         tile: Number of tile/matrix chain devices.
+        switch: Number of LIFX Switch devices (relays, no lighting).
         tile_count: Number of tiles per device. Uses product defaults if not
             specified (5 for Tile, 1 for Candle/Ceiling).
         tile_width: Width of each tile in zones. Uses product defaults if not
@@ -310,7 +312,7 @@ async def run(
             lifx-emulator --color 2 --multizone 1 --tile 1 --api --verbose
 
         Create only specific device types:
-            lifx-emulator --color 0 --infrared 3 --hev 2
+            lifx-emulator --color 0 --infrared 3 --hev 2 --switch 2
 
         Custom serial prefix:
             lifx-emulator --serial-prefix cafe00 --color 5
@@ -410,6 +412,7 @@ async def run(
                 and infrared == 0
                 and hev == 0
                 and multizone == 0
+                and switch == 0
             ):
                 color = 0
 
@@ -423,6 +426,7 @@ async def run(
             and hev == 0
             and multizone == 0
             and tile == 0
+            and switch == 0
         ):
             color = 0
 
@@ -467,13 +471,17 @@ async def run(
                 )
             )
 
+        # Create switch devices
+        for _ in range(switch):
+            devices.append(create_switch(get_serial(), storage=storage))
+
     if not devices:
         if persistent:
             logger.warning("No devices configured. Server will run with no devices.")
             logger.info("Use API (--api) or restart with device flags to add devices.")
         else:
             logger.error(
-                "No devices configured. Use --color, --multizone, --tile, "
+                "No devices configured. Use --color, --multizone, --tile, --switch, "
                 "etc. to add devices."
             )
             return
@@ -520,7 +528,7 @@ async def run(
     # Start API server if enabled
     api_task = None
     if api:
-        from lifx_emulator.api import run_api_server
+        from lifx_emulator_app.api import run_api_server
 
         logger.info("Starting HTTP API server on http://%s:%s", api_host, api_port)
         api_task = asyncio.create_task(run_api_server(server, api_host, api_port))

{lifx_emulator → lifx_emulator_app}/api/__init__.py

@@ -10,7 +10,7 @@ of concerns.
 """
 
 # Import from new refactored structure
-from lifx_emulator.api.app import create_api_app, run_api_server
+from lifx_emulator_app.api.app import create_api_app, run_api_server
 
 # Note: HTML_UI remains in the old lifx_emulator/api.py file temporarily
 # TODO: Phase 1.1d - extract HTML template to separate file

{lifx_emulator → lifx_emulator_app}/api/app.py

@@ -19,9 +19,9 @@ from fastapi.templating import Jinja2Templates
 if TYPE_CHECKING:
     from lifx_emulator.server import EmulatedLifxServer
 
-from lifx_emulator.api.routers.devices import create_devices_router
-from lifx_emulator.api.routers.monitoring import create_monitoring_router
-from lifx_emulator.api.routers.scenarios import create_scenarios_router
+from lifx_emulator_app.api.routers.devices import create_devices_router
+from lifx_emulator_app.api.routers.monitoring import create_monitoring_router
+from lifx_emulator_app.api.routers.scenarios import create_scenarios_router
 
 logger = logging.getLogger(__name__)
 

{lifx_emulator → lifx_emulator_app}/api/mappers/__init__.py

@@ -1,5 +1,5 @@
 """Mappers for converting domain models to API models."""
 
-from lifx_emulator.api.mappers.device_mapper import DeviceMapper
+from lifx_emulator_app.api.mappers.device_mapper import DeviceMapper
 
 __all__ = ["DeviceMapper"]

{lifx_emulator → lifx_emulator_app}/api/mappers/device_mapper.py

@@ -7,7 +7,7 @@ from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from lifx_emulator.devices import EmulatedLifxDevice
 
-from lifx_emulator.api.models import ColorHsbk, DeviceInfo
+from lifx_emulator_app.api.models import ColorHsbk, DeviceInfo
 
 
 class DeviceMapper:

{lifx_emulator → lifx_emulator_app}/api/models.py

@@ -1,9 +1,8 @@
 """Pydantic models for API requests and responses."""
 
-from pydantic import BaseModel, Field, field_validator
-
 # Import shared domain models
 from lifx_emulator.scenarios import ScenarioConfig
+from pydantic import BaseModel, Field, field_validator
 
 
 class DeviceCreateRequest(BaseModel):

lifx_emulator_app/api/routers/__init__.py

@@ -0,0 +1,11 @@
+"""API routers for LIFX emulator endpoints."""
+
+from lifx_emulator_app.api.routers.devices import create_devices_router
+from lifx_emulator_app.api.routers.monitoring import create_monitoring_router
+from lifx_emulator_app.api.routers.scenarios import create_scenarios_router
+
+__all__ = [
+    "create_monitoring_router",
+    "create_devices_router",
+    "create_scenarios_router",
+]

{lifx_emulator → lifx_emulator_app}/api/routers/devices.py

@@ -9,8 +9,8 @@ from fastapi import APIRouter, HTTPException
 if TYPE_CHECKING:
     from lifx_emulator.server import EmulatedLifxServer
 
-from lifx_emulator.api.models import DeviceCreateRequest, DeviceInfo
-from lifx_emulator.api.services.device_service import (
+from lifx_emulator_app.api.models import DeviceCreateRequest, DeviceInfo
+from lifx_emulator_app.api.services.device_service import (
     DeviceAlreadyExistsError,
     DeviceCreationError,
     DeviceNotFoundError,

{lifx_emulator → lifx_emulator_app}/api/routers/monitoring.py

@@ -9,7 +9,7 @@ from fastapi import APIRouter
 if TYPE_CHECKING:
     from lifx_emulator.server import EmulatedLifxServer
 
-from lifx_emulator.api.models import ActivityEvent, ServerStats
+from lifx_emulator_app.api.models import ActivityEvent, ServerStats
 
 
 def create_monitoring_router(server: EmulatedLifxServer) -> APIRouter:

{lifx_emulator → lifx_emulator_app}/api/routers/scenarios.py

@@ -9,7 +9,7 @@ from fastapi import APIRouter, HTTPException
 if TYPE_CHECKING:
     from lifx_emulator.server import EmulatedLifxServer
 
-from lifx_emulator.api.models import ScenarioConfig, ScenarioResponse
+from lifx_emulator_app.api.models import ScenarioConfig, ScenarioResponse
 
 
 def _validate_device_serial(serial: str) -> bool:

lifx_emulator_app/api/services/__init__.py

@@ -0,0 +1,8 @@
+"""Business logic services for API endpoints."""
+
+from lifx_emulator_app.api.services.device_service import DeviceService
+
+# TODO: Create ScenarioService (Phase 1.1b completion)
+# from lifx_emulator_app.api.services.scenario_service import ScenarioService
+
+__all__ = ["DeviceService"]

{lifx_emulator → lifx_emulator_app}/api/services/device_service.py

@@ -13,10 +13,11 @@ from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from lifx_emulator.server import EmulatedLifxServer
 
-from lifx_emulator.api.mappers import DeviceMapper
-from lifx_emulator.api.models import DeviceCreateRequest, DeviceInfo
 from lifx_emulator.factories import create_device
 
+from lifx_emulator_app.api.mappers import DeviceMapper
+from lifx_emulator_app.api.models import DeviceCreateRequest, DeviceInfo
+
 logger = logging.getLogger(__name__)
 
 

lifx_emulator/__init__.py

@@ -1,31 +0,0 @@
-"""LIFX Emulator
-
-A comprehensive LIFX emulator for testing LIFX LAN protocol libraries.
-Implements the binary UDP protocol documented at https://lan.developer.lifx.com
-"""
-
-from importlib.metadata import version as get_version
-
-from lifx_emulator.devices import EmulatedLifxDevice
-from lifx_emulator.factories import (
-    create_color_light,
-    create_color_temperature_light,
-    create_hev_light,
-    create_infrared_light,
-    create_multizone_light,
-    create_tile_device,
-)
-from lifx_emulator.server import EmulatedLifxServer
-
-__version__ = get_version("lifx_emulator")
-
-__all__ = [
-    "EmulatedLifxServer",
-    "EmulatedLifxDevice",
-    "create_color_light",
-    "create_color_temperature_light",
-    "create_hev_light",
-    "create_infrared_light",
-    "create_multizone_light",
-    "create_tile_device",
-]

lifx_emulator/api/routers/__init__.py

@@ -1,11 +0,0 @@
-"""API routers for LIFX emulator endpoints."""
-
-from lifx_emulator.api.routers.devices import create_devices_router
-from lifx_emulator.api.routers.monitoring import create_monitoring_router
-from lifx_emulator.api.routers.scenarios import create_scenarios_router
-
-__all__ = [
-    "create_monitoring_router",
-    "create_devices_router",
-    "create_scenarios_router",
-]

lifx_emulator/api/services/__init__.py

@@ -1,8 +0,0 @@
-"""Business logic services for API endpoints."""
-
-from lifx_emulator.api.services.device_service import DeviceService
-
-# TODO: Create ScenarioService (Phase 1.1b completion)
-# from lifx_emulator.api.services.scenario_service import ScenarioService
-
-__all__ = ["DeviceService"]

lifx_emulator/constants.py

@@ -1,33 +0,0 @@
-"""Protocol constants for LIFX LAN Protocol"""
-
-from typing import Final
-
-# ============================================================================
-# Network Constants
-# ============================================================================
-
-# LIFX UDP port for device communication
-LIFX_UDP_PORT: Final[int] = 56700
-
-# LIFX Protocol version
-LIFX_PROTOCOL_VERSION: Final[int] = 1024
-
-# Header size in bytes
-LIFX_HEADER_SIZE: Final[int] = 36
-
-# Backward compatibility alias
-HEADER_SIZE = LIFX_HEADER_SIZE
-
-# ============================================================================
-# Official LIFX Repository URLs
-# ============================================================================
-
-# Official LIFX protocol specification URL
-PROTOCOL_URL: Final[str] = (
-    "https://raw.githubusercontent.com/LIFX/public-protocol/refs/heads/main/protocol.yml"
-)
-
-# Official LIFX products specification URL
-PRODUCTS_URL: Final[str] = (
-    "https://raw.githubusercontent.com/LIFX/products/refs/heads/master/products.json"
-)

lifx_emulator/devices/__init__.py

@@ -1,37 +0,0 @@
-"""Device management module for LIFX emulator.
-
-This module contains all device-related functionality including:
-- Device core (EmulatedLifxDevice)
-- Device manager (DeviceManager, IDeviceManager)
-- Device states (DeviceState and related dataclasses)
-- Device persistence (async file storage)
-- State restoration and serialization
-- Device state observers (ActivityObserver, ActivityLogger, PacketEvent, NullObserver)
-"""
-
-from lifx_emulator.devices.device import EmulatedLifxDevice
-from lifx_emulator.devices.manager import DeviceManager, IDeviceManager
-from lifx_emulator.devices.observers import (
-    ActivityLogger,
-    ActivityObserver,
-    NullObserver,
-    PacketEvent,
-)
-from lifx_emulator.devices.persistence import (
-    DEFAULT_STORAGE_DIR,
-    DevicePersistenceAsyncFile,
-)
-from lifx_emulator.devices.states import DeviceState
-
-__all__ = [
-    "EmulatedLifxDevice",
-    "DeviceManager",
-    "IDeviceManager",
-    "DeviceState",
-    "DevicePersistenceAsyncFile",
-    "DEFAULT_STORAGE_DIR",
-    "ActivityObserver",
-    "ActivityLogger",
-    "PacketEvent",
-    "NullObserver",
-]