sig-cloud-control 0.1.0__py3-none-any.whl

sig_cloud_control/__init__.py

@@ -0,0 +1,14 @@
+"""Sigenergy Cloud Control Library."""
+
+from .client import APIError, AuthenticationError, SigCloudClient, SigCloudError, StationError
+from .models import Config, OperationMode
+
+__all__ = [
+    "APIError",
+    "AuthenticationError",
+    "Config",
+    "OperationMode",
+    "SigCloudClient",
+    "SigCloudError",
+    "StationError",
+]

sig_cloud_control/cli_app/__init__.py

@@ -0,0 +1,249 @@
+import asyncio
+import logging
+import os
+import sys
+import tomllib
+from pathlib import Path
+from typing import Annotated
+
+import tomli_w
+import typer
+from platformdirs import user_config_path
+from pydantic import ValidationError
+from rich.console import Console
+
+from sig_cloud_control.client import SigCloudClient, SigCloudError
+from sig_cloud_control.models import Config
+
+app = typer.Typer(help="Control a Sigen solar/battery station.")
+
+console = Console()
+
+_DEFAULT_CONFIG_PATH: Path = user_config_path("sig-cloud-control") / "config.toml"
+
+
+def _resolve_config_path(config_opt: str | None) -> Path:
+    """Resolve config path: explicit CLI arg > ./config.toml > platform default."""
+    if config_opt is not None:
+        return Path(config_opt)
+    local = Path("config.toml")
+    if local.exists():
+        return local
+    return _DEFAULT_CONFIG_PATH
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context) -> None:
+    """Control a Sigen solar/battery station."""
+    if ctx.invoked_subcommand is None:
+        typer.secho("Missing command.", fg=typer.colors.RED, err=True)
+        typer.echo(ctx.get_help())
+        raise typer.Exit(code=1)
+
+
+def perform_setup(config_path: Path) -> Config:
+    """Interactively prompt for credentials and save to file."""
+    typer.echo(f"Setting up new configuration at '{config_path}'...")
+    username = typer.prompt("Sigen Cloud login name (eg. user@example.com)")
+    password = typer.prompt("Sigen Cloud Password", hide_input=True)
+    station_id_str = typer.prompt("Station ID (optional, press Enter to skip)", default="")
+
+    password_encoded = SigCloudClient.encrypt_password(password)
+
+    station_id = int(station_id_str) if station_id_str.strip().isdigit() else None
+
+    config_data: dict[str, object] = {
+        "username": username,
+        "password_encoded": password_encoded,
+    }
+    if station_id:
+        config_data["station_id"] = station_id
+
+    config_path.parent.mkdir(parents=True, exist_ok=True)
+    fd = os.open(config_path, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
+    with os.fdopen(fd, "wb") as f:
+        tomli_w.dump(config_data, f)
+
+    typer.secho("✔︎  ", fg=typer.colors.GREEN, bold=True, nl=False)
+    typer.secho(f"Success! Configuration saved to {config_path}", fg=typer.colors.GREEN)
+    typer.echo("Note: Your password has been encrypted for storage.")
+
+    return Config(username=username, password_encoded=password_encoded, station_id=station_id)
+
+
+def load_config(config_path: Path) -> Config:
+    """Load configuration from environment variables and/or TOML file.
+
+    Precedence:
+    1. SIGEN_* Environment Variables
+    2. TOML file at config_path
+    3. Interactive setup (if both are missing)
+    """
+    typer.echo("Loading configuration...")
+
+    # Load from environment variables first
+    try:
+        # Config.model_validate({}) triggers environment variable loading
+        # If it returns a valid config, then environment variables have everything we need.
+        return Config.model_validate({})
+    except ValidationError:
+        # Not enough in env vars, we'll try to supplement with the file
+        pass
+
+    if not config_path.exists():
+        typer.secho(f"⚠️  Config file not found at '{config_path}'", fg=typer.colors.YELLOW)
+        return perform_setup(config_path)
+
+    try:
+        with open(config_path, "rb") as f:
+            file_data = tomllib.load(f)
+
+        # Get what we have from environment variables (even if it's incomplete)
+        env_vars: dict[str, object] = {
+            "username": os.environ.get("SIGEN_USERNAME"),
+            "password": os.environ.get("SIGEN_PASSWORD"),
+            "password_encoded": os.environ.get("SIGEN_PASSWORD_ENCODED"),
+            "station_id": os.environ.get("SIGEN_STATION_ID"),
+        }
+        # Filter out None values and convert types
+        env_vars = {k: v for k, v in env_vars.items() if v is not None}
+        if "station_id" in env_vars and isinstance(env_vars["station_id"], str) and env_vars["station_id"].isdigit():
+            env_vars["station_id"] = int(env_vars["station_id"])
+
+        # Merge: Environment Variables OVER file data
+        merged_data = {**file_data, **env_vars}
+        return Config.model_validate(merged_data)
+    except ValidationError as e:
+        typer.secho(
+            f"❌ Error: Invalid configuration format in '{config_path}':\n{e}",
+            fg=typer.colors.RED,
+            err=True,
+        )
+        raise typer.Exit(code=1) from e
+
+
+async def execute_action(
+    config: Config,
+    action: str,
+    duration: int = 0,
+    power: float | None = None,
+    verbose: bool = False,
+) -> None:
+    """Internal helper to run the async client logic."""
+    if verbose:
+        logging.basicConfig(
+            level=logging.DEBUG,
+            format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+            stream=sys.stderr,
+        )
+
+    async with SigCloudClient(config) as client:
+        typer.echo("Logging in to Sigen Cloud...")
+        await client.login()
+
+        with console.status(f"Executing '{action}' action...", spinner="dots"):
+            if action == "charge":
+                await client.charge_battery(duration, power)
+            elif action == "discharge":
+                await client.discharge_battery(duration, power)
+            elif action == "hold":
+                await client.hold_battery(duration)
+            elif action == "self-consumption":
+                await client.self_consumption(duration)
+            elif action == "cancel":
+                await client.cancel_self_control()
+
+    console.print(f"[bold green]✔︎  [/bold green]Executing '{action}' action... [bold green]Done.[/bold green]")
+
+
+# Common types for CLI arguments and options to reduce duplication
+DurationArg = Annotated[int, typer.Argument(help="Duration in minutes (1-1440)", min=1, max=1440)]
+PowerOpt = Annotated[float | None, typer.Option(help="Charge/discharge rate limit for the battery in kW")]
+ConfigOpt = Annotated[str | None, typer.Option(help="Path to the TOML configuration file")]
+VerboseOpt = Annotated[bool, typer.Option("--verbose", "-v", help="Enable verbose logging")]
+
+
+def _run_command_action(
+    action: str,
+    duration: int = 0,
+    power: float | None = None,
+    config: str | None = None,
+    verbose: bool = False,
+) -> None:
+    """Internal helper to load config and run an action."""
+    conf = load_config(_resolve_config_path(config))
+    try:
+        asyncio.run(execute_action(conf, action, duration, power, verbose))
+    except SigCloudError as e:
+        typer.secho(f"❌ Sigen API Error: {e}", fg=typer.colors.RED, err=True)
+        raise typer.Exit(code=1) from e
+
+
+@app.command()
+def charge(
+    duration: DurationArg,
+    power: PowerOpt = None,
+    config: ConfigOpt = None,
+    verbose: VerboseOpt = False,
+) -> None:
+    """Charge battery from the grid for a specified duration."""
+    _run_command_action("charge", duration, power, config, verbose)
+
+
+@app.command()
+def discharge(
+    duration: DurationArg,
+    power: PowerOpt = None,
+    config: ConfigOpt = None,
+    verbose: VerboseOpt = False,
+) -> None:
+    """Discharge battery for a specified duration."""
+    _run_command_action("discharge", duration, power, config, verbose)
+
+
+@app.command()
+def hold(
+    duration: DurationArg,
+    config: ConfigOpt = None,
+    verbose: VerboseOpt = False,
+) -> None:
+    """Hold battery at its current state of charge for a specified duration."""
+    _run_command_action("hold", duration, config=config, verbose=verbose)
+
+
+@app.command(name="self-consumption")
+def self_consumption(
+    duration: DurationArg,
+    config: ConfigOpt = None,
+    verbose: VerboseOpt = False,
+) -> None:
+    """Enable self-consumption mode for a specified duration."""
+    _run_command_action("self-consumption", duration, config=config, verbose=verbose)
+
+
+@app.command()
+def cancel(
+    config: ConfigOpt = None,
+    verbose: VerboseOpt = False,
+) -> None:
+    """Return the battery to its configured default mode."""
+    _run_command_action(action="cancel", config=config, verbose=verbose)
+
+
+@app.command()
+def setup(
+    config: Annotated[str | None, typer.Option(help="Path to the TOML configuration file to create")] = None,
+) -> None:
+    """Interactively setup credentials and save to config file."""
+    config_path = Path(config) if config else _DEFAULT_CONFIG_PATH
+    if config_path.exists():
+        typer.secho(
+            f"⚠️  Warning: Configuration file '{config_path}' already exists and will be overwritten.",
+            fg=typer.colors.YELLOW,
+        )
+
+    perform_setup(config_path)
+
+
+if __name__ == "__main__":
+    app()

sig_cloud_control/client.py

@@ -0,0 +1,328 @@
+import asyncio
+import base64
+import logging
+import os
+import time
+from http import HTTPStatus
+from pathlib import Path
+from typing import Final
+from uuid import uuid4
+
+import httpx
+from cryptography.hazmat.primitives import padding
+from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+from platformdirs import user_cache_path
+from pydantic import ValidationError
+
+from .models import (
+    MAX_DURATION_MINS,
+    Config,
+    LoginResponse,
+    OperationMode,
+    SetModeRequest,
+    TokenCache,
+)
+
+logger = logging.getLogger(__name__)
+
+_DEFAULT_CACHE_PATH: Final[Path] = user_cache_path("sig-cloud-control") / "token-cache.json"
+
+
+class SigCloudError(Exception):
+    """Base exception for SigCloudClient."""
+
+
+class AuthenticationError(SigCloudError):
+    """Raised when login fails (bad credentials or token error)."""
+
+
+class StationError(SigCloudError):
+    """Raised when the station ID cannot be resolved or is unknown."""
+
+
+class APIError(SigCloudError):
+    """Raised when the Sigen API returns an unexpected or unparseable response."""
+
+
+class SigCloudClient:
+    """Client for interacting with Sigen Cloud API."""
+
+    # TODO: Support additional regions (currently only Australian data centre)
+    _BASE_URL: Final[str] = "https://api-aus.sigencloud.com"
+    _AUTH_URL: Final[str] = f"{_BASE_URL}/auth/oauth/token"
+    _MANUAL_MODE_URL: Final[str] = f"{_BASE_URL}/device/energy-profile/instant/manunal"
+    _STATION_INFO_URL: Final[str] = f"{_BASE_URL}/device/owner/station/home"
+
+    # Fixed key and IV used by Sigen Cloud
+    _ENCRYPT_KEY: Final[bytes] = (b"s" + b"i" + b"g" + b"e" + b"n") * 3 + b"p"
+    _ENCRYPT_IV: Final[bytes] = (b"s" + b"i" + b"g" + b"e" + b"n") * 3 + b"p"
+    _CIPHER: Final[Cipher] = Cipher(
+        algorithms.AES(_ENCRYPT_KEY),
+        modes.CBC(_ENCRYPT_IV),
+    )
+
+    def __init__(self, config: Config, cache_path: Path | None = _DEFAULT_CACHE_PATH) -> None:
+        """Initialize the client with configuration."""
+        self.config = config
+        self.cache_path = cache_path
+        self.client = httpx.AsyncClient()
+        self.access_token: str | None = None
+        self._station_id: int | None = config.station_id
+
+        # Setup base headers mimicking the app
+        self._session_id = str(uuid4())
+        self.client.headers.update(
+            {
+                "accept": "*/*",
+                "accept-language": "en-GB,en-US;q=0.9,en;q=0.8",
+                "auth-client-id": "sigen",
+                "client-server": "aus",
+                "lang": "en_US",
+                "origin": "https://app-aus.sigencloud.com",
+                "referer": "https://app-aus.sigencloud.com/",
+                "sec-ch-ua": '"Not:A-Brand";v="99", "Google Chrome";v="145", "Chromium";v="145"',
+                "sec-ch-ua-mobile": "?0",
+                "sec-ch-ua-platform": '"macOS"',
+                "sec-fetch-dest": "empty",
+                "sec-fetch-mode": "cors",
+                "sec-fetch-site": "same-site",
+                "sg-bui": "1",
+                "sg-env": "1",
+                "sg-pkg": "sigen_app",
+                "sg-session": self._session_id,
+                "sg-v": "3.4.0",
+                "user-agent": (
+                    "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) "
+                    "AppleWebKit/537.36 (KHTML, like Gecko) "
+                    "Chrome/145.0.0.0 Safari/537.36"
+                ),
+            }
+        )
+
+    async def __aenter__(self) -> "SigCloudClient":
+        """Enter the async context manager."""
+        return self
+
+    async def __aexit__(self, *args: object) -> None:
+        """Exit the async context manager and close the HTTP client."""
+        await self.aclose()
+
+    def _get_ts_headers(self) -> dict[str, str]:
+        return {
+            "sg-log-id": str(uuid4()),
+            "sg-ts": str(int(time.time() * 1_000_000)),
+        }
+
+    async def _try_login_from_cache(self) -> bool:
+        """Attempt to load credentials from the local cache. Returns True if successful."""
+        if self.cache_path is None:
+            return False
+
+        cache = await self._load_cache()
+        if not cache:
+            return False
+
+        # Recover station_id from cache if we don't have it yet
+        if self._station_id is None:
+            self._station_id = cache.station_id
+
+        if cache.expires_at > time.time() + 60:  # Valid for at least another minute
+            logger.debug("Using cached token")
+            self.access_token = cache.access_token
+            self.client.headers["authorization"] = f"bearer {self.access_token}"
+            return True
+        return False
+
+    def _get_login_payload(self) -> dict[str, str]:
+        """Prepare the payload for the login request."""
+        if self.config.password_encoded:
+            password_to_send = self.config.password_encoded
+        elif self.config.password:
+            password_to_send = self.encrypt_password(self.config.password)
+        else:
+            # Unreachable due to Config validation
+            msg = "Neither password nor password_encoded provided"
+            raise SigCloudError(msg)
+
+        return {
+            "scope": "server",
+            "grant_type": "password",
+            "userDeviceId": str(int(time.time() * 1000)),
+            "username": self.config.username,
+            "password": password_to_send,
+        }
+
+    @staticmethod
+    def encrypt_password(password: str) -> str:
+        """Encrypt a plaintext password using Sigen's AES-128-CBC logic."""
+        padder = padding.PKCS7(128).padder()
+        padded_data = padder.update(password.encode()) + padder.finalize()
+
+        encryptor = SigCloudClient._CIPHER.encryptor()
+        ct = encryptor.update(padded_data) + encryptor.finalize()
+
+        return base64.b64encode(ct).decode()
+
+    async def login(self, use_cache: bool = True) -> None:
+        """Authenticate with the Sigen API and store the access token. Checks cache first."""
+        if use_cache and await self._try_login_from_cache():
+            return
+
+        logger.info("Logging in to Sigen Cloud as %s", self.config.username)
+        headers = self._get_ts_headers()
+        headers["authorization"] = "Basic c2lnZW46c2lnZW4="
+        headers["content-type"] = "application/x-www-form-urlencoded"
+
+        data = self._get_login_payload()
+
+        response = await self.client.post(self._AUTH_URL, headers=headers, data=data)
+
+        if response.status_code != HTTPStatus.OK:
+            logger.error("Login failed with status %s: %s", response.status_code, response.text)
+            raise AuthenticationError(f"Login failed with status {response.status_code}: {response.text}")
+
+        try:
+            payload = response.json()
+            # Handle potential wrapping or direct payload
+            token_data = payload.get("data", payload) if isinstance(payload, dict) else payload
+            login_response = LoginResponse.model_validate(token_data)
+        except ValidationError as e:
+            logger.error("Failed to parse login response: %s", response.text)
+            raise APIError(f"Failed to parse login response. Raw payload: {response.text}. Error: {e}") from e
+        except Exception as e:
+            logger.error("Unexpected error parsing login response: %s", response.text)
+            raise APIError(f"Unexpected error parsing login response: {e}. Raw payload: {response.text}") from e
+
+        self.access_token = login_response.access_token
+        self.client.headers["authorization"] = f"bearer {self.access_token}"
+
+        # If station_id wasn't provided in config, fetch it
+        if self._station_id is None:
+            await self._fetch_station_id()
+
+        await self._save_cache(login_response.expires_in_secs)
+        logger.info("Successfully logged in and cached token")
+
+    async def _load_cache(self) -> TokenCache | None:
+        """Load the token from the cache file if it exists and is valid."""
+        if self.cache_path is None:
+            return None
+        try:
+            content = await asyncio.to_thread(self.cache_path.read_text)
+            return TokenCache.model_validate_json(content)
+        except (FileNotFoundError, ValidationError):
+            return None
+        except Exception:
+            return None
+
+    def _write_cache_file(self, content: str) -> None:
+        """Helper to write the cache file securely with restricted permissions."""
+        if self.cache_path is None:
+            return
+        self.cache_path.parent.mkdir(parents=True, exist_ok=True)
+        fd = os.open(self.cache_path, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
+        with os.fdopen(fd, "w", encoding="utf-8") as f:
+            f.write(content)
+
+    async def _save_cache(self, expires_in: int) -> None:
+        """Save the current token and station ID to the cache file."""
+        if self.cache_path is None or self.access_token is None:
+            return
+        cache = TokenCache(
+            access_token=self.access_token,
+            expires_at=time.time() + expires_in,
+            station_id=self._station_id,
+        )
+        content = cache.model_dump_json()
+        await asyncio.to_thread(self._write_cache_file, content)
+
+    async def _fetch_station_id(self) -> None:
+        """Fetch the station ID from the home info endpoint."""
+        logger.debug("Fetching station ID from %s", self._STATION_INFO_URL)
+        headers = self._get_ts_headers()
+        response = await self.client.get(self._STATION_INFO_URL, headers=headers)
+        response.raise_for_status()
+
+        data = response.json()
+        if data.get("code") == 0 and "data" in data:
+            self._station_id = data["data"].get("stationId")
+
+        if self._station_id is None:
+            logger.error("Could not retrieve station ID. Response: %s", response.text)
+            raise StationError("Could not retrieve station ID from Sigen Cloud.")
+        logger.debug("Fetched station ID: %s", self._station_id)
+
+    async def _set_mode_raw(
+        self,
+        mode: OperationMode,
+        duration: int | None = None,
+        power_limitation: float | None = None,
+    ) -> None:
+        """Directly set the manual mode on the station."""
+        if not self.access_token:
+            raise SigCloudError("Not logged in. Call login() first.")
+
+        if self._station_id is None:
+            raise StationError("Station ID unknown. Login may have failed to retrieve it.")
+
+        request_data = SetModeRequest(
+            station_id=self._station_id,
+            mode=mode,
+            duration=duration,
+            power_limitation=power_limitation,
+        )
+
+        logger.debug("Sending mode update: %s", request_data.model_dump(by_alias=True))
+        headers = self._get_ts_headers()
+        headers["content-type"] = "application/json; charset=utf-8"
+
+        response = await self.client.put(
+            self._MANUAL_MODE_URL,
+            headers=headers,
+            json=request_data.model_dump(mode="json", by_alias=True),
+        )
+        response.raise_for_status()
+        logger.info("Successfully updated mode to %s", mode.name)
+
+    async def _start_mode(
+        self,
+        mode: OperationMode,
+        duration_min: int,
+        power_kw: float | None = None,
+    ) -> None:
+        """Execute the full sequence to start a manual mode."""
+        if duration_min <= 0 or duration_min > MAX_DURATION_MINS:
+            raise SigCloudError(f"Duration must be between 1 and {MAX_DURATION_MINS} minutes (24 hours).")
+
+        # UI always sends a cancel before starting a new mode
+        await self.cancel_self_control()
+
+        await self._set_mode_raw(
+            mode=mode,
+            duration=duration_min,
+            power_limitation=power_kw,
+        )
+
+    async def charge_battery(self, duration_min: int, power_kw: float | None = None) -> None:
+        """Force charge the battery from the grid."""
+        await self._start_mode(OperationMode.CHARGE, duration_min, power_kw)
+
+    async def discharge_battery(self, duration_min: int, power_kw: float | None = None) -> None:
+        """Force discharge the battery."""
+        await self._start_mode(OperationMode.DISCHARGE, duration_min, power_kw)
+
+    async def hold_battery(self, duration_min: int) -> None:
+        """Hold the battery at its current SOC."""
+        await self._start_mode(OperationMode.HOLD, duration_min)
+
+    async def self_consumption(self, duration_min: int) -> None:
+        """Set to self-consumption mode."""
+        await self._start_mode(OperationMode.SELF_CONSUMPTION, duration_min)
+
+    async def cancel_self_control(self) -> None:
+        """Stop any active manual control."""
+        await self._set_mode_raw(mode=OperationMode.CANCEL)
+
+    async def aclose(self) -> None:
+        """Close the underlying HTTP client."""
+        await self.client.aclose()

sig_cloud_control/models.py

@@ -0,0 +1,141 @@
+import base64
+from enum import StrEnum
+from typing import Final, Self
+
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    EmailStr,
+    Field,
+    field_serializer,
+    field_validator,
+    model_validator,
+)
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+PASSWORD_LEN_BYTES: Final[int] = 16
+MAX_DURATION_MINS: Final[int] = 1440
+MAX_POWER_LIMIT_KW: Final[float] = 100.0
+
+
+class Config(BaseSettings):
+    model_config = SettingsConfigDict(
+        strict=True,
+        env_prefix="SIGEN_",
+        case_sensitive=False,
+    )
+
+    username: EmailStr
+    """The user's Sigen Cloud email address."""
+
+    password: str | None = None
+    """The user's plaintext password (will be encoded automatically)."""
+
+    password_encoded: str | None = None
+    """The base64 encoded/encrypted password from the browser."""
+
+    station_id: int | None = Field(default=None, gt=0)
+    """Optional station ID. Must be positive if provided."""
+
+    @model_validator(mode="after")
+    def validate_password_source(self) -> Self:
+        if self.password is None and self.password_encoded is None:
+            raise ValueError("Either 'password' or 'password_encoded' must be provided")
+        return self
+
+    @field_validator("password_encoded")
+    @classmethod
+    def validate_password_encoded(cls, v: str | None) -> str | None:
+        if v is None:
+            return None
+        try:
+            decoded = base64.b64decode(v, validate=True)
+            if len(decoded) == 0 or len(decoded) % PASSWORD_LEN_BYTES != 0:
+                raise ValueError(
+                    f"Decoded password length ({len(decoded)}) must be a positive multiple of {PASSWORD_LEN_BYTES}"
+                )
+        except Exception as e:
+            if isinstance(e, ValueError) and f"multiple of {PASSWORD_LEN_BYTES}" in str(e):
+                raise
+            raise ValueError("password_encoded must be a valid base64 string") from e
+        return v
+
+
+class LoginResponse(BaseModel):
+    """Standard OAuth 2.0 Access Token Response (RFC 6749, Section 5.1)."""
+
+    access_token: str
+    """The access token issued by the authorisation server."""
+
+    refresh_token: str | None = None
+    """The refresh token, which can be used to obtain new access tokens."""
+
+    token_type: str
+    """The type of the token issued, e.g., 'bearer'."""
+
+    expires_in_secs: int = Field(alias="expires_in")
+    """The lifetime in seconds of the access token."""
+
+
+class TokenCache(BaseModel):
+    access_token: str
+    expires_at: float  # Absolute timestamp
+    station_id: int | None = Field(default=None, gt=0)
+
+
+class OperationMode(StrEnum):
+    CHARGE = "0"
+    DISCHARGE = "1"
+    HOLD = "2"
+    SELF_CONSUMPTION = "3"
+    CANCEL = ""
+
+
+class SetModeRequest(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    mode: OperationMode
+    station_id: int = Field(validation_alias="stationId", serialization_alias="stationId", gt=0)
+    duration: int | None = None
+    power_limitation: float | None = Field(
+        default=None, validation_alias="powerLimitation", serialization_alias="powerLimitation"
+    )
+    enable: bool = False
+
+    @field_serializer("duration", "power_limitation")
+    def serialise_to_str(self, v: int | float | None) -> str:
+        return str(v) if v is not None else ""
+
+    @model_validator(mode="after")
+    def validate_duration_and_power(self) -> Self:
+        self.enable = self.mode != OperationMode.CANCEL
+
+        match self.mode:
+            case OperationMode.CANCEL:
+                if self.duration is not None or self.power_limitation is not None:
+                    raise ValueError("duration and power_limitation must be null/None when mode is CANCEL")
+
+            case OperationMode.CHARGE | OperationMode.DISCHARGE:
+                self._validate_duration()
+                if self.power_limitation is not None:
+                    if self.power_limitation <= 0:
+                        raise ValueError("power_limitation must be a positive number (> 0)")
+                    if self.power_limitation > MAX_POWER_LIMIT_KW:
+                        msg = (
+                            f"power_limitation {self.power_limitation} kW "
+                            f"exceeds sanity limit of {MAX_POWER_LIMIT_KW} kW"
+                        )
+                        raise ValueError(msg)
+
+            case OperationMode.HOLD | OperationMode.SELF_CONSUMPTION:
+                self._validate_duration()
+                if self.power_limitation is not None:
+                    raise ValueError(f"power_limitation is not supported for mode {self.mode.name}")
+        return self
+
+    def _validate_duration(self) -> None:
+        """Shared helper to validate mandatory duration."""
+        if self.duration is None:
+            raise ValueError(f"duration is required for mode {self.mode.name}")
+        if not (1 <= self.duration <= MAX_DURATION_MINS):
+            raise ValueError(f"duration must be between 1 and {MAX_DURATION_MINS} minutes")

sig_cloud_control-0.1.0.dist-info/METADATA

@@ -0,0 +1,251 @@
+Metadata-Version: 2.4
+Name: sig-cloud-control
+Version: 0.1.0
+Summary: Control Sigenergy battery via Sigen Cloud
+Project-URL: Homepage, https://github.com/lawther/sig-cloud-control
+Project-URL: Repository, https://github.com/lawther/sig-cloud-control
+Project-URL: Issues, https://github.com/lawther/sig-cloud-control/issues
+Author-email: Mike Lawther <mike.lawther@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: battery,energy-storage,iot,sigen,sigenergy,solar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: cryptography~=46.0
+Requires-Dist: httpx~=0.28
+Requires-Dist: platformdirs>=4.0
+Requires-Dist: pydantic-settings>=2.14.0
+Requires-Dist: pydantic[email]~=2.12
+Provides-Extra: cli
+Requires-Dist: tomli-w>=1.2.0; extra == 'cli'
+Requires-Dist: typer~=0.24; extra == 'cli'
+Description-Content-Type: text/markdown
+
+# sig-cloud-control
+
+A Python library and CLI for controlling Sigenergy (Sigen Cloud) solar and battery systems.
+
+> [⚠️ CAUTION]
+> **Non-Affiliation & Warning**
+> - **Not Official:** This project is not affiliated with, authorized by, or endorsed by Sigenergy. Use of this tool is at your own risk.
+> - **Warranty Warning:** Using this tool may violate your Sigenergy Terms of Service and could potentially void your hardware warranty. The author is not responsible for any loss of warranty or damage to equipment.
+> - **Reverse Engineering:** This tool was developed for the purpose of interoperability between Sigenergy batteries and third-party automation systems.
+
+## Compatibility
+
+> [⚠️ NOTE]
+> This tool currently only supports the **Australian** Sigen Cloud data centre (`api-aus.sigencloud.com`). Other regions are not yet supported.
+
+## Operations
+
+- `charge`: Force charge the battery from the grid for a specified duration.
+- `discharge`: Force discharge the battery for a specified duration.
+- `hold`: Hold the battery at its current state of charge for a specified duration.
+- `self-consumption`: Enable self-consumption mode for a specified duration. The battery prioritises consuming solar generation.
+- `cancel`: Immediately return the battery to its configured default mode (which may be self-consumption, VPP control, or another mode set by your installer).
+
+> **`self-consumption` vs `cancel`:** Use `self-consumption` to explicitly activate solar-first behaviour for a set period. Use `cancel` to immediately hand control back to the battery's configured default, whatever that may be.
+
+## Installation
+
+### From PyPI (Recommended)
+
+```bash
+pip install sig-cloud-control
+# or using uv
+uv tool install sig-cloud-control
+```
+
+### From Source (Development)
+
+This project uses `uv` for dependency management.
+
+```bash
+# Clone the repository
+git clone https://github.com/lawther/sig-cloud-control.git
+cd sig-cloud-control
+
+# Install dependencies
+uv sync
+```
+
+## Configuration
+
+### Interactive Setup (Recommended for local use)
+
+```bash
+sig-cloud-control setup
+```
+
+This prompts for your credentials, encrypts your password, and saves a config file to the platform default location:
+
+- **macOS/Linux:** `~/.config/sig-cloud-control/config.toml`
+- **Windows:** `%LOCALAPPDATA%\sig-cloud-control\sig-cloud-control\config.toml`
+
+### Config File Discovery
+
+When no `--config` flag is provided, the tool searches for a config file in this order:
+
+1. `./config.toml` in the current directory (for project-local use)
+2. The platform default location above
+
+### Environment Variables (Recommended for Docker/CI)
+
+Environment variables take precedence over the configuration file:
+
+- `SIGEN_USERNAME`: Your Sigen Cloud email address.
+- `SIGEN_PASSWORD_ENCODED`: Your encrypted password (generate with `sig-cloud-control setup`).
+- `SIGEN_PASSWORD`: Your plaintext password (convenient for CI secrets).
+- `SIGEN_STATION_ID`: Your Station ID (optional).
+
+### Config File Format
+
+```toml
+username = "example@example.com"
+
+# Use the encrypted password (generated by `sig-cloud-control setup`):
+password_encoded = "..."
+
+# OR use a plaintext password:
+# password = "your_plaintext_password"
+
+# station_id is optional and will be fetched automatically if omitted.
+# Find it in the Sigen app under Settings -> System Settings -> About.
+# station_id = 12345
+```
+
+## CLI Usage
+
+```bash
+# Setup credentials interactively (saves to platform default config location)
+sig-cloud-control setup
+
+# Charge battery for 60 minutes at 2.5 kW (charge rate limit)
+sig-cloud-control charge 60 --power 2.5
+
+# Discharge battery for 30 minutes at maximum rate
+sig-cloud-control discharge 30
+
+# Hold battery at current state of charge for 60 minutes
+sig-cloud-control hold 60
+
+# Enable self-consumption mode for 30 minutes
+sig-cloud-control self-consumption 30
+
+# Return battery to its default mode immediately
+sig-cloud-control cancel
+
+# Use a specific config file
+sig-cloud-control charge 60 --config /path/to/config.toml
+
+# Enable verbose logging for debugging
+sig-cloud-control charge 60 --verbose
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `--power` | Charge/discharge rate limit in kW (supported by `charge` and `discharge` only) |
+| `--config` | Path to the TOML configuration file |
+| `--verbose`, `-v` | Enable verbose debug logging to stderr |
+
+## API Usage
+
+You can use `sig-cloud-control` as a library in your own asynchronous Python applications. The public API is exposed at the root level:
+
+```python
+import asyncio
+from sig_cloud_control import SigCloudClient, Config
+
+async def main():
+    config = Config(
+        username="user@example.com",
+        password="my_secret_password"
+    )
+
+    # Use as an async context manager — handles cleanup automatically
+    async with SigCloudClient(config) as client:
+        await client.login()
+        await client.charge_battery(duration_min=60, power_kw=5.0)
+        print("Charge command issued successfully.")
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### Token Cache
+
+By default, `SigCloudClient` caches authentication tokens at the platform cache directory (e.g. `~/.cache/sig-cloud-control/token-cache.json` on Linux). To disable caching, pass `cache_path=None`:
+
+```python
+client = SigCloudClient(config, cache_path=None)
+```
+
+### Error Handling
+
+All errors are subclasses of `SigCloudError`. Import the specific types for finer-grained handling:
+
+```python
+from sig_cloud_control import AuthenticationError, StationError, APIError, SigCloudError
+
+async with SigCloudClient(config) as client:
+    try:
+        await client.login()
+    except AuthenticationError:
+        print("Bad credentials — check username/password.")
+    except StationError:
+        print("Could not resolve station ID.")
+    except APIError:
+        print("Unexpected API response.")
+    except SigCloudError:
+        print("Other Sigen Cloud error.")
+```
+
+| Exception | When raised |
+|-----------|-------------|
+| `AuthenticationError` | Login failed (bad credentials or token error) |
+| `StationError` | Station ID could not be resolved or is unknown |
+| `APIError` | Sigen API returned an unexpected or unparseable response |
+| `SigCloudError` | Base class; also raised for pre-condition failures (e.g. invalid duration) |
+
+## Development
+
+This project uses `just` to manage development tasks. The `Justfile` is the Single Source Of Truth (SSOT) for all pre-commit checks and development workflows. No additional linting or testing logic should be added anywhere else (e.g. CI configs).
+
+### Help
+
+```bash
+just
+```
+
+### Running Pre-commit Checks (Lint + Test)
+
+```bash
+just precommit
+```
+
+### Running Tests
+
+```bash
+just test
+```
+
+### Linting and Formatting
+
+```bash
+just lint
+```
+
+## License
+
+Apache 2.0

sig_cloud_control-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+sig_cloud_control/__init__.py,sha256=8OY4qn7gU7OOaBnbhDbRvt9W1sAFCsG846WJcS63RYk,333
+sig_cloud_control/client.py,sha256=o3D0-Oj8_fo5y8dk_W0GmmmlZ5qkcQCG4h-E0ZsGBRw,12811
+sig_cloud_control/models.py,sha256=U1HJiV1ICif9yPbYi0DRQbQJqdJdNwecB5h1nwRBBac,4986
+sig_cloud_control/cli_app/__init__.py,sha256=OWDYcxuAEAyn2LUFMlYabaHbXDtFvV3K9qryu10Bln0,8651
+sig_cloud_control-0.1.0.dist-info/METADATA,sha256=Ey35GKAR444o1HPObfE955F9bAXrFkwIgakxiynHSXw,8124
+sig_cloud_control-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+sig_cloud_control-0.1.0.dist-info/entry_points.txt,sha256=Hv5fP9tcb7X8yQ1Pq_JY2niIpDOhohPSYPAU-SvuHi0,68
+sig_cloud_control-0.1.0.dist-info/licenses/LICENSE,sha256=EEtzlSNOipzD2g_imt3vkGsjZ2DidDtxsP0nj_Yjpsc,11342
+sig_cloud_control-0.1.0.dist-info/RECORD,,

sig_cloud_control-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

sig_cloud_control-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sig-cloud-control = sig_cloud_control.cli_app:app

sig_cloud_control-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Mike Lawther
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.