mkdocs.yml

site_name: Batcontrol Documentation
site_description: >-
  Optimize your electricity costs by re-charging your PV battery when
  electricity is cheap and there is not enough solar power available.
site_url: https://mastr.github.io/batcontrol/
repo_url: https://github.com/MaStr/batcontrol
repo_name: MaStr/batcontrol
edit_uri: edit/main/docs/

theme:
  name: material
  icon:
    logo: material/battery-charging
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.action.edit
    - content.code.copy
    - search.suggest
    - search.highlight

markdown_extensions:
  - admonition
  - attr_list
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details

plugins:
  - search
  # Renders docs/assets/openapi.json, generated by scripts/dump_openapi.py in
  # the docs build, so the published API reference cannot drift from the code.
  - swagger-ui-tag
  - llmstxt:
      markdown_description: |
        Batcontrol controls a PV battery inverter based on dynamic electricity prices,
        solar production forecasts, and consumption patterns. It charges from the grid
        when prices are low and preserves stored energy when prices are high. It supports
        Fronius Gen24 inverters (HTTP API and Modbus TCP) and any inverter via MQTT bridge.
        Tariff providers include Tibber, aWATTar, evcc, EnergyForecast.de, and static zone
        tariffs. Solar forecast sources include Forecast.Solar, Solar-Prognose.de, evcc,
        and Home Assistant Solar Forecast ML. Peak shaving distributes PV battery charging
        across the day using forecasts, and works with both dynamic and static tariffs.
      full_output: llms-full.txt
      sections:
        Getting Started:
          - getting-started/installation.md: Installation guide with pre-flight checklist, Docker setup, and next steps
          - getting-started/how-batcontrol-works.md: Architecture, control loop, forecasting system, and decision logic
        Configuration:
          - configuration/batcontrol-configuration.md: Main configuration file reference
          - configuration/inverter-configuration.md: Fronius Gen24, Fronius Modbus, and MQTT inverter configuration
          - configuration/multiple-inverters.md: Running several inverters/batteries as one aggregated battery
          - configuration/dynamic-tariff-provider.md: Tibber, aWATTar, evcc, EnergyForecast, and static tariff zones
          - configuration/solar-forecast.md: Forecast.Solar, Solar-Prognose.de, evcc, and Home Assistant ML
          - configuration/consumption-forecast.md: CSV load profile and Home Assistant API forecast
        Features:
          - features/peak-shaving.md: Dynamic PV charge rate limiting to maximize solar absorption
          - features/peak-shaving-scenarios.md: Worked example day for every peak shaving rule combination
          - features/battery-control-expert.md: Advanced tuning parameters
          - features/price-difference-calculation.md: How price thresholds are calculated
          - features/decision-sensor.md: How to read the Home Assistant Decision sensor, with worked examples
          - features/dashboard.md: The built-in web dashboard and how to read it
        Integrations:
          - integrations/rest-api.md: Read-only HTTP API, conventions, authentication and the OpenAPI reference
          - integrations/mcp-server.md: MCP server for AI assistants, tools and client setup
          - integrations/mqtt-api.md: MQTT state publishing, runtime overrides, and Home Assistant auto-discovery
          - integrations/mqtt-inverter.md: Integrating any battery system via MQTT bridge
          - integrations/evcc-connection.md: Coordinating with EV charging via evcc
          - integrations/forecast-metrics.md: Forecast data exposed via MQTT
        Optional:
          - development/15-min-transform.md: Internal 15-minute interval resolution
          - development/solar-limit-evaluation.md: Solar feed-in limit (Solarspitzengesetz) evaluation
          - development/decision-trace.md: Decision trace and journal (why did batcontrol do this)
          - development/dashboard-spec.md: Design contract for the built-in web dashboard
          - development/frontend-build.md: Building the dashboard and how it reaches the wheel
          - development/mcp-spec.md: Design contract for the read-only MCP server
          - development/mcp-evaluation.md: Questions for checking the MCP tools against real use

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - How Batcontrol Works: getting-started/how-batcontrol-works.md
  - Configuration:
      - Main Configuration: configuration/batcontrol-configuration.md
      - Inverter: configuration/inverter-configuration.md
      - Multiple Inverters: configuration/multiple-inverters.md
      - Dynamic Tariff Provider: configuration/dynamic-tariff-provider.md
      - Solar Forecast: configuration/solar-forecast.md
      - Consumption Forecast: configuration/consumption-forecast.md
  - Features:
      - Battery Control Expert: features/battery-control-expert.md
      - Peak Shaving: features/peak-shaving.md
      - Peak Shaving Scenarios: features/peak-shaving-scenarios.md
      - Price Difference Calculation: features/price-difference-calculation.md
      - Understanding the Decision Sensor: features/decision-sensor.md
      - Dashboard: features/dashboard.md
  - Integrations:
      - REST API: integrations/rest-api.md
      - MCP Server: integrations/mcp-server.md
      - MQTT API: integrations/mqtt-api.md
      - Forecast Metrics: integrations/forecast-metrics.md
      - MQTT Inverter: integrations/mqtt-inverter.md
      - evcc Connection: integrations/evcc-connection.md
  - Development:
      - 15-Minute Interval Transformation: development/15-min-transform.md
      - Solar Feed-in Limit Evaluation: development/solar-limit-evaluation.md
      - Decision Trace and Journal: development/decision-trace.md
      - Dashboard Specification: development/dashboard-spec.md
      - Frontend Build: development/frontend-build.md
      - MCP Server Specification: development/mcp-spec.md
      - MCP Evaluation: development/mcp-evaluation.md

extra_javascript:
  - assets/js/vendor/chart.umd.js
  - assets/js/peak-shaving-charts.js

extra_css:
  - assets/css/peak-shaving-charts.css

validation:
  links:
    not_found: warn
    unrecognized_links: warn