Tutorials Overview¶

Step-by-step tutorials to master the LIFX Emulator, organized from beginner to advanced.

Learning Path¶

Follow these tutorials in order for the best learning experience:

🟢 Beginner - First Device - Your first emulated LIFX device (⏱️ 10-15 minutes)
🟢 Beginner - Basic Usage - Multiple devices and basic operations (⏱️ 15-30 minutes)
🟡 Intermediate - Integration Testing - Using the emulator in test suites (⏱️ 30-45 minutes)
🔴 Advanced - Advanced Scenarios - Error injection and complex testing (⏱️ 45-60 minutes)
🔴 Advanced - CI/CD Integration - Automated testing pipelines (⏱️ 30-45 minutes)

Tutorial Categories¶

Getting Started¶

Learn the basics:

Creating a single device
Starting the server
Using the context manager
Basic server configuration

Multiple Devices¶

Work with multiple devices:

Creating different device types
Managing device collections
Testing multi-device scenarios

Testing Integration¶

Integrate with test frameworks:

pytest fixtures
pytest-asyncio usage
Module-scoped fixtures
Test isolation strategies

Error Scenarios¶

Test error handling:

Packet dropping
Response delays
Malformed packets
Invalid field values
Partial responses

Complete Example¶

Here's a complete example showing multiple features:

import asyncio
import pytest
from lifx_emulator import (
    EmulatedLifxServer,
    create_color_light,
    create_multizone_light,
    create_tile_device,
)

@pytest.fixture
async def lifx_devices():
    """Create a diverse set of emulated devices."""
    devices = [
        create_color_light("d073d5000001"),
        create_color_light("d073d5000002"),
        create_multizone_light("d073d8000001", zone_count=16),
        create_multizone_light("d073d8000002", zone_count=82, extended_multizone=True),
        create_tile_device("d073d9000001", tile_count=5),
    ]

    # Configure error scenarios for one device
    devices[0].scenarios = {
        'response_delays': {102: 0.1},  # Delay SetColor by 100ms
    }

    return devices

@pytest.fixture
async def lifx_server(lifx_devices):
    """Start emulator server with devices."""
    server = EmulatedLifxServer(lifx_devices, "127.0.0.1", 56700)

    async with server:
        yield server

@pytest.mark.asyncio
async def test_discovery(lifx_server):
    """Test device discovery."""
    # Your test code here
    pass

@pytest.mark.asyncio
async def test_color_control(lifx_server):
    """Test color control commands."""
    # Your test code here
    pass

Next Steps¶

Browse the specific tutorial pages for detailed code samples and explanations. Each tutorial builds on the concepts from the previous one.