lifx-emulator 2.4.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

lifx_emulator/products/specs.py

@@ -1,284 +0,0 @@
-"""Product specs and defaults for LIFX devices.
-
-This module provides access to product-specific details that are not available
-in the upstream LIFX products.json catalog, such as default zone counts and
-tile configurations.
-"""
-
-from __future__ import annotations
-
-from dataclasses import dataclass
-from pathlib import Path
-
-import yaml
-
-
-@dataclass
-class ProductSpecs:
-    """Product-specific specs and defaults.
-
-    Attributes:
-        product_id: Product ID this applies to
-        default_zone_count: Default number of zones for multizone devices
-        min_zone_count: Minimum zones supported
-        max_zone_count: Maximum zones supported
-        default_tile_count: Default number of tiles in chain
-        min_tile_count: Minimum tiles supported
-        max_tile_count: Maximum tiles supported
-        tile_width: Width of each tile in zones
-        tile_height: Height of each tile in zones
-        default_firmware_major: Default firmware major version
-        default_firmware_minor: Default firmware minor version
-        notes: Human-readable notes about this product
-    """
-
-    product_id: int
-    default_zone_count: int | None = None
-    min_zone_count: int | None = None
-    max_zone_count: int | None = None
-    default_tile_count: int | None = None
-    min_tile_count: int | None = None
-    max_tile_count: int | None = None
-    tile_width: int | None = None
-    tile_height: int | None = None
-    default_firmware_major: int | None = None
-    default_firmware_minor: int | None = None
-    notes: str | None = None
-
-    @property
-    def has_multizone_specs(self) -> bool:
-        """Check if this product has multizone-specific specs."""
-        return self.default_zone_count is not None
-
-    @property
-    def has_matrix_specs(self) -> bool:
-        """Check if this product has matrix-specific specs."""
-        return self.tile_width is not None or self.tile_height is not None
-
-    @property
-    def has_firmware_specs(self) -> bool:
-        """Check if this product has firmware version specs."""
-        return (
-            self.default_firmware_major is not None
-            and self.default_firmware_minor is not None
-        )
-
-
-class SpecsRegistry:
-    """Registry of product specs loaded from specs.yml."""
-
-    def __init__(self) -> None:
-        """Initialize empty specs registry."""
-        self._specs: dict[int, ProductSpecs] = {}
-        self._loaded = False
-
-    def load_from_file(self, specs_path: Path | None = None) -> None:
-        """Load specs from YAML file.
-
-        Args:
-            specs_path: Path to specs.yml file. If None, uses default location.
-        """
-        if specs_path is None:
-            specs_path = Path(__file__).parent / "specs.yml"
-
-        if not specs_path.exists():
-            # No specs file, that's okay - we'll use registry defaults only
-            self._loaded = True
-            return
-
-        with open(specs_path) as f:
-            data = yaml.safe_load(f)
-
-        if not data or "products" not in data:
-            self._loaded = True
-            return
-
-        # Parse product specs
-        for pid, specs_data in data["products"].items():
-            self._specs[int(pid)] = ProductSpecs(
-                product_id=int(pid),
-                default_zone_count=specs_data.get("default_zone_count"),
-                min_zone_count=specs_data.get("min_zone_count"),
-                max_zone_count=specs_data.get("max_zone_count"),
-                default_tile_count=specs_data.get("default_tile_count"),
-                min_tile_count=specs_data.get("min_tile_count"),
-                max_tile_count=specs_data.get("max_tile_count"),
-                tile_width=specs_data.get("tile_width"),
-                tile_height=specs_data.get("tile_height"),
-                default_firmware_major=specs_data.get("default_firmware_major"),
-                default_firmware_minor=specs_data.get("default_firmware_minor"),
-                notes=specs_data.get("notes"),
-            )
-
-        self._loaded = True
-
-    @property
-    def is_loaded(self) -> bool:
-        """Check if specs have been loaded."""
-        return self._loaded
-
-    def get_specs(self, product_id: int) -> ProductSpecs | None:
-        """Get specs for a specific product.
-
-        Args:
-            product_id: Product ID to look up
-
-        Returns:
-            ProductSpecs if found, None otherwise
-        """
-        if not self._loaded:
-            self.load_from_file()
-
-        return self._specs.get(product_id)
-
-    def has_specs(self, product_id: int) -> bool:
-        """Check if a product has specs defined.
-
-        Args:
-            product_id: Product ID to check
-
-        Returns:
-            True if specs exist for this product
-        """
-        if not self._loaded:
-            self.load_from_file()
-
-        return product_id in self._specs
-
-    def get_default_zone_count(self, product_id: int) -> int | None:
-        """Get default zone count for a multizone product.
-
-        Args:
-            product_id: Product ID
-
-        Returns:
-            Default zone count if defined, None otherwise
-        """
-        specs = self.get_specs(product_id)
-        return specs.default_zone_count if specs else None
-
-    def get_default_tile_count(self, product_id: int) -> int | None:
-        """Get default tile count for a matrix product.
-
-        Args:
-            product_id: Product ID
-
-        Returns:
-            Default tile count if defined, None otherwise
-        """
-        specs = self.get_specs(product_id)
-        return specs.default_tile_count if specs else None
-
-    def get_tile_dimensions(self, product_id: int) -> tuple[int, int] | None:
-        """Get tile dimensions for a matrix product.
-
-        Args:
-            product_id: Product ID
-
-        Returns:
-            Tuple of (width, height) if defined, None otherwise
-        """
-        specs = self.get_specs(product_id)
-        if specs and specs.tile_width and specs.tile_height:
-            return (specs.tile_width, specs.tile_height)
-        return None
-
-    def get_default_firmware_version(self, product_id: int) -> tuple[int, int] | None:
-        """Get default firmware version for a product.
-
-        Args:
-            product_id: Product ID
-
-        Returns:
-            Tuple of (major, minor) if defined, None otherwise
-        """
-        specs = self.get_specs(product_id)
-        if specs and specs.has_firmware_specs:
-            # has_firmware_specs ensures both values are not None
-            assert specs.default_firmware_major is not None  # nosec
-            assert specs.default_firmware_minor is not None  # nosec
-            return (specs.default_firmware_major, specs.default_firmware_minor)
-        return None
-
-    def __len__(self) -> int:
-        """Get number of products with specs."""
-        if not self._loaded:
-            self.load_from_file()
-        return len(self._specs)
-
-    def __contains__(self, product_id: int) -> bool:
-        """Check if product has specs."""
-        return self.has_specs(product_id)
-
-
-# Global specs registry instance
-_specs_registry = SpecsRegistry()
-
-
-def get_specs_registry() -> SpecsRegistry:
-    """Get the global specs registry.
-
-    Returns:
-        Global SpecsRegistry instance
-    """
-    return _specs_registry
-
-
-def get_specs(product_id: int) -> ProductSpecs | None:
-    """Get specs for a specific product.
-
-    Args:
-        product_id: Product ID to look up
-
-    Returns:
-        ProductSpecs if found, None otherwise
-    """
-    return _specs_registry.get_specs(product_id)
-
-
-def get_default_zone_count(product_id: int) -> int | None:
-    """Get default zone count for a multizone product.
-
-    Args:
-        product_id: Product ID
-
-    Returns:
-        Default zone count if defined, None otherwise
-    """
-    return _specs_registry.get_default_zone_count(product_id)
-
-
-def get_default_tile_count(product_id: int) -> int | None:
-    """Get default tile count for a matrix product.
-
-    Args:
-        product_id: Product ID
-
-    Returns:
-        Default tile count if defined, None otherwise
-    """
-    return _specs_registry.get_default_tile_count(product_id)
-
-
-def get_tile_dimensions(product_id: int) -> tuple[int, int] | None:
-    """Get tile dimensions for a matrix product.
-
-    Args:
-        product_id: Product ID
-
-    Returns:
-        Tuple of (width, height) if defined, None otherwise
-    """
-    return _specs_registry.get_tile_dimensions(product_id)
-
-
-def get_default_firmware_version(product_id: int) -> tuple[int, int] | None:
-    """Get default firmware version for a product.
-
-    Args:
-        product_id: Product ID
-
-    Returns:
-        Tuple of (major, minor) if defined, None otherwise
-    """
-    return _specs_registry.get_default_firmware_version(product_id)

lifx_emulator/products/specs.yml

@@ -1,386 +0,0 @@
-# LIFX Product Specs and Defaults
-# =================================
-#
-# This file contains product-specific details that are not available in the
-# upstream LIFX products.json catalog, such as default zone counts, tile
-# configurations, firmware versions, and other device-specific defaults.
-#
-# These values are used by the emulator to create realistic device
-# configurations when specific parameters are not provided by the user.
-#
-# Format:
-# -------
-# products:
-#   <product_id>:
-#     # For multizone devices
-#     default_zone_count: <number>      # Default zones (e.g., 16)
-#     min_zone_count: <number>          # Minimum zones supported
-#     max_zone_count: <number>          # Maximum zones supported
-#
-#     # For matrix devices (tiles, candles, etc.)
-#     default_tile_count: <number>      # Default number of tiles in chain
-#     min_tile_count: <number>          # Minimum tiles supported
-#     max_tile_count: <number>          # Maximum tiles supported
-#     tile_width: <number>              # Width of each tile in zones
-#     tile_height: <number>             # Height of each tile in zones
-#
-#     # Host firmware version (optional, overrides auto firmware selection)
-#     default_firmware_major: <number>  # Firmware major version (e.g., 3)
-#     default_firmware_minor: <number>  # Firmware minor version (e.g., 70)
-#
-#     # Other device-specific defaults
-#     notes: "<string>"                 # Notes about product
-#
-# Firmware Version Notes:
-# ----------------------
-# If default_firmware_major and default_firmware_minor are both specified
-# they will be used as the default firmware version when creating devices
-# of that type. This overrides the automatic firmware version selection
-# based on extended_multizone capability (which defaults to 3.70 for extended
-# multizone or 2.60 for non-extended).
-#
-# Precedence order for firmware version:
-# 1. Explicit firmware_version parameter to create_device()
-# 2. Product-specific default from this specs.yml file
-# 3. Automatic selection based on extended_multizone flag
-
-products:
-  # ========================================
-  # Multizone Products (Linear Strips)
-  # ========================================
-
-  31:  # Original LIFX Z strip, 2 meters, 8 zones per meter
-    default_zone_count: 16
-    min_zone_count: 8
-    max_zone_count: 16
-    notes: Original LIFX Z strip, 2 meters, 8 zones per meter
-
-  32:  # LIFX Z with extended multizone firmware support
-    default_zone_count: 16
-    min_zone_count: 8
-    max_zone_count: 16
-    notes: LIFX Z with extended multizone firmware support
-
-  38:  # LIFX Beam, 8 individual beams, each with 10 zones and up to 2 corners
-    default_zone_count: 80
-    min_zone_count: 10
-    max_zone_count: 82
-    notes: LIFX Beam, 8 individual beams, each with 10 zones and up to 2 corners
-
-  117:  # LIFX Z US variant
-    default_zone_count: 16
-    min_zone_count: 8
-    max_zone_count: 16
-    notes: LIFX Z US variant
-
-  118:  # LIFX Z International variant
-    default_zone_count: 16
-    min_zone_count: 8
-    max_zone_count: 16
-    notes: LIFX Z International variant
-
-  119:  # LIFX Beam US variant
-    default_zone_count: 80
-    min_zone_count: 10
-    max_zone_count: 82
-    notes: LIFX Beam US variant
-
-  120:  # LIFX Beam International variant
-    default_zone_count: 80
-    min_zone_count: 10
-    max_zone_count: 82
-    notes: LIFX Beam International variant
-
-  141:  # LIFX Neon flexible light strip
-    default_zone_count: 24
-    min_zone_count: 24
-    max_zone_count: 48
-    notes: LIFX Neon flexible light strip
-
-  142:  # LIFX Neon International variant
-    default_zone_count: 24
-    min_zone_count: 24
-    max_zone_count: 48
-    notes: LIFX Neon International variant
-
-  143:  # LIFX String lights
-    default_zone_count: 36
-    min_zone_count: 36
-    max_zone_count: 72
-    notes: LIFX String lights
-
-  144:  # LIFX String International variant
-    default_zone_count: 20
-    min_zone_count: 36
-    max_zone_count: 72
-    notes: LIFX String International variant
-
-  161:  # LIFX Outdoor Neon
-    default_zone_count: 60
-    min_zone_count: 60
-    max_zone_count: 120
-    notes: LIFX Outdoor Neon
-
-  162:  # LIFX Outdoor Neon International variant
-    default_zone_count: 60
-    min_zone_count: 60
-    max_zone_count: 120
-    notes: LIFX Outdoor Neon International variant
-
-  203:  # LIFX String US (newer model)
-    default_zone_count: 36
-    min_zone_count: 36
-    max_zone_count: 72
-    notes: LIFX String US (newer model)
-
-  204:  # LIFX String International (newer model)
-    default_zone_count: 36
-    min_zone_count: 36
-    max_zone_count: 72
-    notes: LIFX String International (newer model)
-
-  205:  # LIFX Indoor Neon US
-    default_zone_count: 24
-    min_zone_count: 24
-    max_zone_count: 48
-    notes: LIFX Indoor Neon US
-
-  206:  # LIFX Indoor Neon Intl
-    default_zone_count: 24
-    min_zone_count: 24
-    max_zone_count: 48
-    notes: LIFX Indoor Neon Intl
-
-  213:  # LIFX Permanent Outdoor US
-    default_zone_count: 30
-    min_zone_count: 30
-    max_zone_count: 120
-    notes: LIFX Permanent Outdoor US
-
-  214:  # LIFX Permanent Outdoor Intl
-    default_zone_count: 30
-    min_zone_count: 30
-    max_zone_count: 120
-    notes: LIFX Permanent Outdoor Intl
-
-  # ========================================
-  # Matrix Products (Tiles, Candles, etc.)
-  # ========================================
-
-  55:  # LIFX Tile, 8x8 zone matrix, chainable up to 5
-    default_tile_count: 5
-    min_tile_count: 1
-    max_tile_count: 5
-    tile_width: 8
-    tile_height: 8
-    notes: LIFX Tile, 8x8 zone matrix, chainable up to 5
-
-  57:  # LIFX Candle, 5x6 zone matrix, single unit
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle, 5x6 zone matrix, single unit
-
-  68:  # LIFX Candle variant, 5x6 zone matrix
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle variant, 5x6 zone matrix
-
-  137:  # LIFX Candle Color US 5x6 variant
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle Color US 5x6 variant
-
-  138:  # LIFX Candle Colour 5x6 International variant
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle Colour 5x6 International variant
-
-  171:  # LIFX Round Spot, 3x1 matrix
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 3
-    tile_height: 1
-    notes: LIFX Round Spot, 3x1 matrix
-
-  173:  # LIFX Round Path, 3x2 matrix
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 3
-    tile_height: 2
-    notes: LIFX Round Path, 3x2 matrix
-
-  174:  # LIFX Square Path, 3x2 matrix
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 3
-    tile_height: 2
-    notes: LIFX Square Path, 3x2 matrix
-
-  176:  # LIFX Ceiling, 8x8 matrix, zones 1-63: downlight, zone 64: uplight
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 8
-    tile_height: 8
-    default_firmware_major: 4
-    default_firmware_minor: 10
-    notes: 'LIFX Ceiling, 8x8 matrix, zones 1-63: downlight, zone 64: uplight'
-
-  177:  # LIFX Ceiling Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 8
-    tile_height: 8
-    default_firmware_major: 4
-    default_firmware_minor: 10
-    notes: LIFX Ceiling Intl
-
-  185:  # LIFX Candle Color US
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle Color US
-
-  186:  # LIFX Candle Colour Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle Colour Intl
-
-  201:  # LIFX Ceiling 13x26" US
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 16
-    tile_height: 8
-    default_firmware_major: 4
-    default_firmware_minor: 10
-    notes: LIFX Ceiling 13x26" US
-
-  202:  # LIFX Ceiling 13x26" Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 16
-    tile_height: 8
-    default_firmware_major: 4
-    default_firmware_minor: 10
-    notes: LIFX Ceiling 13x26" Intl
-
-  215:  # LIFX Candle Color US
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle Color US
-
-  216:  # LIFX Candle Colour Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 6
-    notes: LIFX Candle Colour Intl
-
-  217:  # LIFX Tube US
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 11
-    notes: LIFX Tube US
-
-  218:  # LIFX Tube Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 5
-    tile_height: 11
-    notes: LIFX Tube Intl
-
-  219:  # LIFX Luna US
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 7
-    tile_height: 5
-    notes: LIFX Luna US
-
-  220:  # LIFX Luna Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 7
-    tile_height: 5
-    notes: LIFX Luna Intl
-
-  221:  # LIFX Round Spot Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 3
-    tile_height: 1
-    notes: LIFX Round Spot Intl
-
-  222:  # LIFX Round Path Intl
-    default_tile_count: 1
-    min_tile_count: 1
-    max_tile_count: 1
-    tile_width: 3
-    tile_height: 2
-    notes: LIFX Round Path Intl
-
-  # ========================================
-  # Switch Products (Relays)
-  # ========================================
-
-  70:  # LIFX Switch
-    relay_count: 2
-    default_firmware_major: 4
-    default_firmware_minor: 100
-    notes: LIFX Switch
-
-  71:  # LIFX Switch
-    relay_count: 2
-    default_firmware_major: 4
-    default_firmware_minor: 100
-    notes: LIFX Switch
-
-  89:  # LIFX Switch
-    relay_count: 2
-    default_firmware_major: 4
-    default_firmware_minor: 100
-    notes: LIFX Switch
-
-  115:  # LIFX Switch
-    relay_count: 2
-    default_firmware_major: 4
-    default_firmware_minor: 100
-    notes: LIFX Switch
-
-  116:  # LIFX Switch
-    relay_count: 2
-    default_firmware_major: 4
-    default_firmware_minor: 100
-    notes: LIFX Switch

lifx_emulator/protocol/__init__.py

@@ -1 +0,0 @@
-"""LIFX protocol implementation and code generation."""