mylightsystems 0.0.8

Asynchronous Python client for MyLight Systems.

Python: MyLight Systems API Client

Asynchronous Python client for the MyLight Systems API, enabling programmatic control and monitoring of MyLight Systems solar energy and home automation devices.

Features

🔋 Device Management - Control and monitor solar panels, batteries, relays, and sensors ⚡ Real-time Data - Get live power consumption, production, and device states 🏠 Home Automation - Switch devices on/off and automate energy management 📊 Energy Monitoring - Track total energy production, consumption, and efficiency metrics 🔐 Secure Authentication - Token-based API authentication with error handling 🚀 Async/Await - Built for modern Python with full async support

Installation

Install from PyPI:

pip install mylightsystems

Quick Start

import asyncio
from mylightsystems.client import MyLightSystemsApiClient

async def main():
    async with MyLightSystemsApiClient() as client:
        # Authenticate
        auth = await client.auth("[e-mail]", "your_password")

        # Get user profile
        profile = await client.get_profile(auth.token)
        print(f"User: {profile.id} in {profile.city}, {profile.country}")

        # Get all devices
        devices = await client.get_devices(auth.token)
        print(f"Found {len(devices)} devices")

if __name__ == "__main__":
    asyncio.run(main())

API Overview

The client provides methods to interact with all major MyLight Systems endpoints:

Method	Description	Documentation
auth(email, password)	Authenticate and get access token	📖 Auth
get_profile(token)	Get user profile information	📖 Profile
get_devices(token)	List all connected devices	📖 Devices
get_states(token)	Get real-time device states and sensor data	📖 States
get_measures_total(token, device_id)	Get total energy measures for a device	📖 Measures
switch(token, device_id, state)	Control device on/off state	📖 Switch

Device Types

The library supports all MyLight Systems device types:

• 🏠 Master Device (mst) - Main control unit
• 🔋 Battery Device (bat) - Energy storage systems
• 🔌 Relay Device (sw) - Controllable switches and outlets
• 📊 Counter Device (cmp) - Energy measurement devices
• 📈 Composite Counter (gmd) - Multi-phase energy meters
• 💻 Virtual Device (vrt) - Software-defined devices
• 🌐 Ethernet Device (eth) - Network-connected devices

Each device type has specific properties and capabilities. See the Device Models documentation for complete details.

Documentation

📚 Complete API Documentation - Comprehensive guide with examples and advanced usage patterns

Quick Links

• Getting Started - Complete setup and usage examples
• Advanced Usage - Energy monitoring, automation, and health monitoring
• Error handling - Comprehensive error handling patterns
• Retry Patterns - Production-ready resilience strategies

API Reference

• Authentication - Login and token management
• User Profile - Get account information
• Device Management - List and identify devices
• Device States - Real-time monitoring
• Energy Measures - Total energy data
• Device Control - Switch devices on/off

Reference Guides

• Data Models - All data structures and fields
• Exception Handling - Error types and handling patterns

Use Cases

Perfect for building:

🏠 Home Energy Management - Real-time monitoring dashboards and automated energy optimization 🔌 IoT Integration - Home Assistant components, OpenHAB bindings, Node-RED flows 📊 Energy Analytics - Historical analysis, solar forecasting, cost optimization 🤖 Smart Automation - Intelligent device control based on production and consumption

See the complete documentation for detailed examples and implementation patterns.

Requirements

• Python 3.8+
• aiohttp
• Modern async/await support

Contributing

We welcome contributions! This project uses modern Python development tools:

• mise for tool management
• uv for dependency management
• ruff for linting and formatting
• pre-commit for automated checks

Development Setup

# Install mise for tool management
curl https://mise.run | sh

# Set up the project
mise install
mise run project:setup

Development Commands

# Run all checks and tests
mise run precommit:run

# Run tests only
mise run project:tests

# Run linting
mise run project:lint

# Fix linting issues
mise run project:lint-fix

See our Contributing Guidelines for detailed information.

Authors & Contributors

Created and maintained by Pierre-Emmanuel Mercier.

For a full list of contributors, see the contributor's page.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

MyLight Systems is a trademark of MyLight Systems SAS. This project is an unofficial client library and is not affiliated with or endorsed by MyLight Systems SAS.