# lifx-async

> A modern, type-safe, async Python library for controlling LIFX lights

lifx-async is a modern, type-safe, async Python library for controlling LIFX smart devices
over the local network. Built with Python's built-in asyncio for async/await patterns and
features auto-generated protocol structures from a YAML specification.

Key features:
- Zero runtime dependencies
- Full async/await support with asyncio
- Type-safe with strict Pyright validation
- Auto-generated protocol from official LIFX specification
- Supports all LIFX lighting device types: Light, HevLight, InfraredLight, MultiZoneLight, MatrixLight, and CeilingLight
- High-level API with device discovery and batch operations
- Concurrent request handling with connection pooling

## Getting Started

- [Installation](https://djelibeybi.github.io/lifx-async/getting-started/installation/index.md)
- [Quick Start](https://djelibeybi.github.io/lifx-async/getting-started/quickstart/index.md)
- [Themes](https://djelibeybi.github.io/lifx-async/getting-started/themes/index.md)
- [Built-in Theme Catalogue](https://djelibeybi.github.io/lifx-async/getting-started/built-in-themes/index.md)
- [Light Effects](https://djelibeybi.github.io/lifx-async/getting-started/effects/index.md)

## User Guide

- [Discovery](https://djelibeybi.github.io/lifx-async/user-guide/discovery/index.md)
- [Themes](https://djelibeybi.github.io/lifx-async/user-guide/themes/index.md)
- [Ceiling Lights](https://djelibeybi.github.io/lifx-async/user-guide/ceiling-lights/index.md)
- [Mirror Lights](https://djelibeybi.github.io/lifx-async/user-guide/mirror-lights/index.md)
- [Animation](https://djelibeybi.github.io/lifx-async/user-guide/animation/index.md)
- [Advanced Usage](https://djelibeybi.github.io/lifx-async/user-guide/advanced-usage/index.md)
- [Custom Effects](https://djelibeybi.github.io/lifx-async/user-guide/effects-custom/index.md)
- [Troubleshooting](https://djelibeybi.github.io/lifx-async/user-guide/troubleshooting/index.md)
- [Effects Troubleshooting](https://djelibeybi.github.io/lifx-async/user-guide/effects-troubleshooting/index.md)
- [Protocol Deep Dive](https://djelibeybi.github.io/lifx-async/architecture/protocol-deep-dive/index.md)

## Architecture

- [Overview](https://djelibeybi.github.io/lifx-async/architecture/overview/index.md)
- [Effects System](https://djelibeybi.github.io/lifx-async/architecture/effects-architecture/index.md)

## API Reference

- [Overview](https://djelibeybi.github.io/lifx-async/api/index.md)
- [High-Level API](https://djelibeybi.github.io/lifx-async/api/high-level/index.md)
- [Themes](https://djelibeybi.github.io/lifx-async/api/themes/index.md)
- [Effects](https://djelibeybi.github.io/lifx-async/api/effects/index.md)
- [Animation](https://djelibeybi.github.io/lifx-async/api/animation/index.md)
- [Color Utilities](https://djelibeybi.github.io/lifx-async/api/colors/index.md)
- [Device Classes](https://djelibeybi.github.io/lifx-async/api/devices/index.md)
- [Network Layer](https://djelibeybi.github.io/lifx-async/api/network/index.md)
- [Protocol Layer](https://djelibeybi.github.io/lifx-async/api/protocol/index.md)
- [Exceptions](https://djelibeybi.github.io/lifx-async/api/exceptions/index.md)

## Migration

- [Effect API Changes](https://djelibeybi.github.io/lifx-async/migration/effect-api-changes/index.md)
- [Theme Taxonomy Changes](https://djelibeybi.github.io/lifx-async/migration/theme-taxonomy-6.4.0/index.md)
- [mDNS Low-Level API Removal](https://djelibeybi.github.io/lifx-async/migration/mdns-low-level-api-7.0.0/index.md)
- [UDP receive_many() Removal](https://djelibeybi.github.io/lifx-async/migration/udp-receive-many-removal-7.0.1/index.md)

## Additional Resources

- [FAQ](https://djelibeybi.github.io/lifx-async/faq/index.md)
- [Changelog](https://djelibeybi.github.io/lifx-async/changelog/index.md)