### Install openWB Core

Source: https://github.com/openwb/core/blob/master/README.md

Execute this command in the shell to install the openWB core software. Ensure you are using a compatible Debian 11 'Bullseye' system.

```bash
curl -s https://raw.githubusercontent.com/openWB/core/master/openwb-install.sh | sudo bash
```

--------------------------------

### Datastore Upgrade Function Example

Source: https://github.com/openwb/core/blob/master/docs/Neues Modul programmieren.md

An example of an upgrade function for Datastore version 104, which adds missing configuration parameters for the aWATTar provider. It iterates through MQTT topics, decodes payloads, checks for specific conditions, and updates configurations if necessary.

```python
def upgrade_datastore_104(self) -> None:
    """Upgrade-Funktion für Datastore-Version 104: Ergänzt fehlende aWATTar-Konfigurationsparameter"""
    def upgrade(topic: str, payload) -> None:
        """Prüft und migriert ein einzelnes MQTT-Topic"""
        # Topic finden, das aktualisiert werden soll
        if "openWB/optional/ep/flexible_tariff/provider" == topic:
            provider = decode_payload(payload)
            # Nur für aWATTar-Provider ausführen
            if provider["type"] == "awattar":
                # Prüfen, ob das "net"-Feld fehlt (neue Konfiguration)
                if provider["configuration"].get("net") is None:
                    # Standardwerte für fehlende Konfigurationsparameter setzen
                    provider["configuration"]["net"] = False
                    provider["configuration"]["fix"] = 0.015
                    provider["configuration"]["proportional"] = 0.03
                    provider["configuration"]["tax"] = 0.2
                    # Aktualisierte Konfiguration zurückgeben
                    return {topic: provider}
    # Alle gespeicherten MQTT-Topics durchlaufen und Upgrade-Funktion anwenden
    self._loop_all_received_topics(upgrade)
    # Diese Upgrade-Funktion als ausgeführt markieren (Version 104)
    self._append_datastore_version(104)
```

--------------------------------

### LG Device API - Correct Auth Key

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

This example demonstrates a successful POST request to the /v1/user/essinfo/home endpoint using a valid authentication key. The response contains detailed device statistics and operational information.

```bash
$ curl -k -d '{"auth_key":"67567d76-0c83-11ea-8a59-d84fb802005a"}' -H "Content-Type: application/json" -X POST https://192.168.0.248/v1/user/essinfo/home
{
    "statistics":
    {
        "pcs_pv_total_power": "0",
        "batconv_power": "372",
        "bat_use": "1",
        "bat_status": "2",
        "bat_user_soc": "14.58333",
        "load_power": "361",
        "load_today": "0.0",
        "grid_power": "11",
        "current_day_self_consumption": "94.8",
        "current_pv_generation_sum": "7415",
        "current_grid_feed_in_energy": "385"
    },
    "direction":
    {
        "is_direct_consuming_": "0",
        "is_battery_charging_": "0",
        "is_battery_discharging_": "1",
        "is_grid_selling_": "0",
        "is_grid_buying_": "0",
        "is_charging_from_grid_": "0"
    },
    "operation":
    {
        "status": "start",
        "mode": "1"
    },
    "wintermode":
    {
        "winter_status": "on"
    },
    "pcs_fault":
    {
        "pcs_status": "pcs_ok"
    }
}
```

--------------------------------

### LG Device API - Incorrect Auth Key

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

This example shows the response when an incorrect or invalid authentication key is used in a POST request to the /v1/user/essinfo/home endpoint.

```bash
$ curl -k -d '{"auth_key":"a7df86bc-092c-11ea-8a59-d84fb802005a"}' -H "Content-Type: application/json" -X POST https://192.168.0.248/v1/user/essinfo/home
{
    "auth": "auth_key failed"
}
```

--------------------------------

### Get ESS Home Information (Valid Auth Key)

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

Retrieves detailed ESS home information using a valid authentication key.

```APIDOC
## POST /v1/user/essinfo/home (Valid Auth Key)

### Description
Retrieves detailed ESS home information, including statistics, operational direction, and status, using a valid authentication key.

### Method
POST

### Endpoint
https://192.168.0.248/v1/user/essinfo/home

### Request Body
- **auth_key** (string) - Required - The authentication key.

### Request Example
{
  "auth_key": "67567d76-0c83-11ea-8a59-d84fb802005a"
}

### Response
#### Success Response (200)
- **statistics** (object) - Contains energy-related statistics.
  - **pcs_pv_total_power** (string) - Total PV power.
  - **batconv_power** (string) - Battery conversion power.
  - **bat_use** (string) - Battery usage indicator.
  - **bat_status** (string) - Battery status.
  - **bat_user_soc** (string) - Battery state of charge.
  - **load_power** (string) - Load power.
  - **load_today** (string) - Today's load energy.
  - **grid_power** (string) - Grid power.
  - **current_day_self_consumption** (string) - Current day self-consumption percentage.
  - **current_pv_generation_sum** (string) - Total PV generation for the current day.
  - **current_grid_feed_in_energy** (string) - Current grid feed-in energy.
- **direction** (object) - Indicates the direction of energy flow.
  - **is_direct_consuming_** (string) - Whether directly consuming.
  - **is_battery_charging_** (string) - Whether battery is charging.
  - **is_battery_discharging_** (string) - Whether battery is discharging.
  - **is_grid_selling_** (string) - Whether selling to the grid.
  - **is_grid_buying_** (string) - Whether buying from the grid.
  - **is_charging_from_grid_** (string) - Whether charging from the grid.
- **operation** (object) - Operational status.
  - **status** (string) - Operation status.
  - **mode** (string) - Operation mode.
- **wintermode** (object) - Winter mode status.
  - **winter_status** (string) - Winter mode status.
- **pcs_fault** (object) - PCS fault status.
  - **pcs_status** (string) - PCS status.

#### Response Example
{
    "statistics": {
        "pcs_pv_total_power": "0",
        "batconv_power": "372",
        "bat_use": "1",
        "bat_status": "2",
        "bat_user_soc": "14.58333",
        "load_power": "361",
        "load_today": "0.0",
        "grid_power": "11",
        "current_day_self_consumption": "94.8",
        "current_pv_generation_sum": "7415",
        "current_grid_feed_in_energy": "385"
    },
    "direction": {
        "is_direct_consuming_": "0",
        "is_battery_charging_": "0",
        "is_battery_discharging_": "1",
        "is_grid_selling_": "0",
        "is_grid_buying_": "0",
        "is_charging_from_grid_": "0"
    },
    "operation": {
        "status": "start",
        "mode": "1"
    },
    "wintermode": {
        "winter_status": "on"
    },
    "pcs_fault": {
        "pcs_status": "pcs_ok"
    }
}
```

--------------------------------

### Get ESS Home Information (Invalid Auth Key)

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

Attempts to retrieve ESS home information with an invalid authentication key.

```APIDOC
## POST /v1/user/essinfo/home (Invalid Auth Key)

### Description
Retrieves ESS home information. This example shows the response when an invalid auth_key is provided.

### Method
POST

### Endpoint
https://192.168.0.248/v1/user/essinfo/home

### Request Body
- **auth_key** (string) - Required - The authentication key.

### Request Example
{
  "auth_key": "a7df86bc-092c-11ea-8a59-d84fb802005a"
}

### Response
#### Error Response (401)
- **auth** (string) - Indicates an authentication failure.

#### Response Example
{
    "auth": "auth_key failed"
}
```

--------------------------------

### Initialize System Info Display

Source: https://github.com/openwb/core/blob/master/web/maintenance/systeminfo.html

Sets up interval for data fetching, initializes history storage, loads Chart.js, and prepares chart containers. It defines functions to update historical data and display current system metrics.

```javascript
const fetchInterval = 5000; // 5 Sekunden
const maxHistoryLength = 60; // z.B. 5 Minuten bei 5s Intervall
// Verlaufsspeicher für alle Daten
const history = {};
// Chart.js laden
const chartJsScript = document.createElement("script");
chartJsScript.src = "chart.umd.min.js";
document.head.appendChild(chartJsScript);
// Warten bis Chart.js geladen ist
function onChartJsReady(cb) {
    if (window.Chart) cb();
    else chartJsScript.onload = cb;
}
// Diagramm-Container
const charts = {};
// Nur für diese Abschnitte werden Diagramme erstellt:
const chartSections = ["cpuLoad", "memory", "storage"];
```

--------------------------------

### Binding and Updating Configuration Values

Source: https://github.com/openwb/core/wiki/Einstellungs-Seite erstellen

Use these lines to correctly associate settings with their respective topics in the broker. The setting name must exactly match the name defined in `config.py`. A help text can be added after the `<template #help>` tag.

```javascript
:model-value="configuration.sample"
@update:model-value="updateConfiguration($event, 'configuration.sample')"
```

--------------------------------

### Display System Data and Handle Interactions

Source: https://github.com/openwb/core/blob/master/web/maintenance/systeminfo.html

Renders system information into HTML, including tables for services and detailed metrics. It also sets up event listeners for restarting services and displaying detailed information.

```javascript
function displayData(data) {
    if (typeof data !== "object" || data === null) {
        document.getElementById("content").innerHTML = "<p>Keine gültigen Daten erhalten.</p>";
        return;
    }
    let html = `<h2>Aktuelle Messwerte <span style="color:#888;font-size:0.95em">(${new Date().toLocaleString()})</span></h2>`;
    html += '<div class="card-container">';
    for (const key in data) {
        if (Object.hasOwn(data, key)) {
            const value = data[key];
            html += `<div class="card"><h2>${key}</h2>`;
            if ( key === "services" && typeof value === "object" && value !== null ) {
                html += '<table style="margin:0; width:100%;">';
                for (const service in value) {
                    if (Object.hasOwn(value, service)) {
                        const status = value[service];
                        const btnId = `restart_${service.replace(/\W/g, "_")}`;
                        html += ` <tr> <th>${service.replace(/\.service/g, "")}</th> <td> <span>${status}</span> <button id="${btnId}" style="margin-left:10px;">Neustart</button> </td> </tr>`;
                    }
                }
                html += "</table>";
            } else if (typeof value === "object" && value !== null) {
                html += '<table style="margin:0; width:100%;">';
                for (const subKey in value) {
                    if (Object.hasOwn(value, subKey)) {
                        const v = value[subKey];
                        html += `<tr><th>${subKey}
`;
                        // Falls "details" vorhanden, einen runden Info-Button anzeigen
                        if (v && typeof v === "object" && "details" in v) {
                            const infoBtnId = `info_${key}_${subKey}`.replace( /\W/g, "_" );
                            html += ` <button class="details-button" data-details="${v.details}">i</button>`;
                        }
                        html += '</th><td style="text-align:right;">';
                        if ( v && typeof v === "object" && "value" in v && "unit" in v ) {
                            let num = Number(v.value);
                            let formatted = isFinite(num) ? num.toFixed(1) : v.value;
                            html += `${formatted} <span style="color:#888;font-size:0.95em">${v.unit}</span>`;
                        } else {
                            html += `${v}`;
                        }
                        html += "</td></tr>";
                    }
                }
                html += "</table>";
            } else {
                html += `<div style="font-size:1.3em;">${value}</div>`;
            }
            html += "</div>";
        }
    }
    html += "</div>";
    document.getElementById("content").innerHTML = html;
    // Event-Handler für Service-Neustart-Buttons
    if (data.services) {
        for (const service in data.services) {
            if (!Object.hasOwn(data.services, service)) continue;
            const btnId = `restart_${service.replace(/\W/g, "_")}`;
            const btn = document.getElementById(btnId);
            if (btn) {
                btn.onclick = async function () {
                    btn.disabled = true;
                    btn.textContent = "Neustart läuft...";
                    try {
                        const response = await fetch("systeminfo_api.php", {
                            method: "POST",
                            headers: {
                                "Content-Type": "application/json",
                            },
                            body: JSON.stringify({
                                action: "restart_service",
                                service: service,
                            }),
                        });
                        const result = await response.json();
                        if (result.status === "ok") {
                            btn.textContent = "Erfolgreich";
                            setTimeout(() => {
                                btn.textContent = "Neustart";
                                btn.disabled = false;
                                fetchSystemInfo();
                            }, 1500);
                        } else {
                            btn.textContent = "Fehler";
                            setTimeout(() => {
                                btn.textContent = "Neustart";
                                btn.disabled = false;
                            }, 2000);
                            alert( "Fehler beim Neustart: " + (result.message || result.output || "") );
                        }
                    } catch (err) {
                        btn.textContent = "Fehler";
                        setTimeout(() => {
                            btn.textContent = "Neustart";
                            btn.disabled = false;
                        }, 2000);
                        alert("Fehler beim Neustart: " + err.message);
                    }
                };
            }
        }
    }
    // Event-Handler für Info-Buttons (Details)
    document.querySelectorAll(".details-button").forEach((btn) => {
        btn.onclick = function () {
            const modal = document.getElementById("details-modal");
            const msg = document.getElementById("details-modal-message");
            msg.textContent = btn.getAttribute("data-details");
            const header = document.getElementById("details-modal-header");
            const th = btn.closest("th");
            let subKeyText = th ? th.childNodes[0].textContent.trim() : "";

```

--------------------------------

### Setting Storage Power Limit

Source: https://github.com/openwb/core/wiki/Neues Modul programmieren

Use the `set_power_limit` method to set the storage's power output in Watts. Passing `None` relinquishes active control, allowing the storage to regulate based on the EVU point.

```python
def set_power_limit(self, power_limit: Optional[int] = None):
    # Implementation to set power limit
```

--------------------------------

### Python: Implementing Power Limit Control for Batteries

Source: https://github.com/openwb/core/blob/master/docs/Neues Modul programmieren.md

Implement `power_limit_controllable` to indicate if a battery supports active power control. Use `set_power_limit` to set the battery's power output in Watts or `None` to disable active control.

```python
def power_limit_controllable(self) -> bool:
    return True

def set_power_limit(self, power: Optional[int] = None):
    # ... implementation ...
    pass
```

--------------------------------

### Python: Using HTTP Session for Requests

Source: https://github.com/openwb/core/blob/master/docs/Neues Modul programmieren.md

Use `req.get_http_session().get/post()` for HTTP requests in modules. This method logs responses, checks for errors, and translates common errors into user-friendly text.

```python
req.get_http_session().get("http://example.com")
```

--------------------------------

### Redirect to OpenWB Web Interface

Source: https://github.com/openwb/core/blob/master/index.html

Use this JavaScript snippet to automatically redirect the user to the OpenWB web interface. If the automatic redirect fails, a manual link is provided.

```javascript
window.location.href = "/openWB/web/"
```

--------------------------------

### Configure SoC Calculation While Charging

Source: https://github.com/openwb/core/blob/master/docs/Neues Modul programmieren.md

Set `calc_while_charging` to `True` in `ConfigurableVehicle` instantiation within `soc.py` if the vehicle's SoC cannot be queried during charging.

```python
from openwb.modules.vehicles.configurable_vehicle import ConfigurableVehicle

# ... other vehicle configurations ...

# For vehicles where SoC cannot be queried during charging:
configurable_vehicle = ConfigurableVehicle(
    # ... other parameters ...
    calc_while_charging=True
)
```

--------------------------------

### LG Home 15 Data Structure

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

Provides a detailed structure for LG Home 15 data, including statistics, energy direction, and operational modes.

```APIDOC
## LG Home 15 Data Structure

### Description
This section details the JSON structure returned for LG Home 15 devices, encompassing various operational and statistical data points.

### Response Example
{
    "statistics": {
        "pv_total_power_01kW": 36,
        "batt_conv_power_01kW": -34,
        "grid_power_01kW": 0,
        "load_power_01kW": 2,
        "ac_active_power_01kW": 3,
        "bat_use": 1,
        "bat_status": 1,
        "bat_user_soc": 46
    },
    "direction": {
        "is_direct_consuming_": 1,
        "is_battery_charging_": 1,
        "is_battery_discharging_": 0,
        "is_grid_selling_": 0,
        "is_grid_buying_": 0,
        "is_charging_from_grid_": 0,
        "is_discharging_to_grid_": 0
    },
    "operation": {
        "status": "start",
        "mode": 1,
        "oper_status": 3,
        "simple_status": 1,
        "backup_mode": 1,
        "remote_mode": 0,
        "demo_mode": 0,
        "tou_period": 1,
        "ripple_control": "0",
        "ripple_level": "0"
    },
    "pcs_fault": {
        "pcs_status": "pcs_ok",
        "grid_fault": "0"
    },
    "heatpump": {
        "heatpump_protocol": "2",
        "heatpump_installed": "no",
        "heatpump_activate": "off",
        "current_temp": 0,
        "heatpump_working": "off"
    },
    "evcharger": {
        "ev_activate": "off",
        "ev_power": 0
    },
    "gridWaitingTime": 0,
    "coredump": "none",
    "factory_test_mode": "none"
}
```

--------------------------------

### Login to LG Device

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

Use this cURL command to log in to the LG device by sending a PUT request with the password. The response includes an authentication key.

```bash
$ curl -k --connect-timeout 5 -d '{"password":"XXXXXXXXXXXX"}' -H "Content-Type: application/json" -X PUT https://192.168.0.248/v1/login
{
    "status": "success",
    "auth_key": "67567d76-0c83-11ea-8a59-d84fb802005a",
    "regnum": "XXXXXXXXXXXX",
    "role": "installer"
}
```

--------------------------------

### Storage Power Limit Controllability Check

Source: https://github.com/openwb/core/wiki/Neues Modul programmieren

Implement the `power_limit_controllable` method to indicate if a storage device supports active power limit control. If not implemented, it defaults to `False`.

```python
def power_limit_controllable(self) -> bool:
    return True
```

--------------------------------

### HTTP Session Management in Common Module

Source: https://github.com/openwb/core/wiki/Neues Modul programmieren

Use `req.get_http_session().get/post()` for HTTP requests in modules. This method logs responses, checks for errors via a callback, and throws exceptions for common issues, translating them into user-friendly text.

```python
req.get_http_session().get/post()
```

--------------------------------

### Login Endpoint

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

Authenticates with the LG device using a password and returns an authentication key.

```APIDOC
## PUT /v1/login

### Description
Authenticates with the LG device using a password.

### Method
PUT

### Endpoint
https://192.168.0.248/v1/login

### Request Body
- **password** (string) - Required - The user's password.

### Request Example
{
  "password": "XXXXXXXXXXXX"
}

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **auth_key** (string) - The authentication key for subsequent requests.
- **regnum** (string) - Registration number.
- **role** (string) - User role.

#### Response Example
{
    "status": "success",
    "auth_key": "67567d76-0c83-11ea-8a59-d84fb802005a",
    "regnum": "XXXXXXXXXXXX",
    "role": "installer"
}
```

--------------------------------

### Context Manager for Exception Handling

Source: https://github.com/openwb/core/wiki/Neues Modul programmieren

The `update` method is called using a context manager that handles exceptions by logging them and setting fault states and messages. This ensures user feedback on errors.

```python
from packages.modules.common.component_context import component_context

with component_context(self):
    # Your update logic here
```

--------------------------------

### Python: Context Manager for Exception Handling

Source: https://github.com/openwb/core/blob/master/docs/Neues Modul programmieren.md

The `update` method is called using a context manager that handles exceptions by logging them and setting fault states. Exceptions should only be caught if they can be resolved or if further actions are needed, in which case they must be re-raised.

```python
with component_context.ComponentContext(self):
    # ... update logic ...
    pass
```

--------------------------------

### Binding and Updating Text Input Values

Source: https://github.com/openwb/core/wiki/Einstellungs-Seite erstellen

These lines are essential within each frame for managing text input values. The first line binds the value to be read from the broker, and the second line handles updating that value.

```javascript
:model-value="$store.state.examples.text3"
@update:model-value="updateState('text3', $event)"
```

--------------------------------

### LG Device API - Detailed Status

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

This JSON object provides a detailed snapshot of the LG device's current status, including power statistics, energy flow direction, operational mode, and winter mode status.

```json
{
    "statistics":
    {
        "pcs_pv_total_power": "0",
        "batconv_power": "372",
        "bat_use": "1",
        "bat_status": "2",
        "bat_user_soc": "14.58333",
        "load_power": "361",
        "load_today": "0.0",
        "grid_power": "11",
        "current_day_self_consumption": "94.8",
        "current_pv_generation_sum": "7415",
        "current_grid_feed_in_energy": "385"
    },
    "direction":
    {
        "is_direct_consuming_": "0",
        "is_battery_charging_": "0",
        "is_battery_discharging_": "1",
        "is_grid_selling_": "0",
        "is_grid_buying_": "0",
        "is_charging_from_grid_": "0"
    },
    "operation":
    {
        "status": "start",
        "mode": "1"
    },
    "wintermode":
    {
        "winter_status": "on"
    },
    "pcs_fault":
    {
        "pcs_status": "pcs_ok"
    }
}
```

--------------------------------

### Submit Run Data Form

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/byd/byd/byd_test_sample_rundata.html

JavaScript function to submit the 'RunData' form. Ensure the form element with id 'RunData' exists on the page.

```javascript
function submitForm(){
 var form = document.getElementById("RunData");
 form.submit();
}
```

--------------------------------

### Update Data History

Source: https://github.com/openwb/core/blob/master/web/maintenance/systeminfo.html

Manages the historical data for system metrics, pushing new data points and removing old ones to maintain a fixed length. Supports nested data structures.

```javascript
function updateHistory(data) {
    for (const key in data) {
        if (!Object.hasOwn(data, key)) continue;
        const value = data[key];
        if (typeof value === "object" && value !== null) {
            if (!history[key]) history[key] = {};
            for (const subKey in value) {
                if (!Object.hasOwn(value, subKey)) continue;
                if (!history[key][subKey]) history[key][subKey] = [];
                history[key][subKey].push({ t: Date.now(), v: value[subKey] });
                if (history[key][subKey].length > maxHistoryLength) history[key][subKey].shift();
            }
        } else {
            if (!history[key]) history[key] = [];
            history[key].push({ t: Date.now(), v: value });
            if (history[key].length > maxHistoryLength) history[key].shift();
        }
    }
}
```

--------------------------------

### LG Home 15 Device Status

Source: https://github.com/openwb/core/blob/master/packages/modules/devices/lg/lg/JSON-Beispiele.txt

This JSON object represents the status of an LG Home 15 device, including statistics, power direction, operation mode, and fault status.

```json
{
    "statistics": {
        "pv_total_power_01kW": 36,
        "batt_conv_power_01kW": -34,
        "grid_power_01kW": 0,
        "load_power_01kW": 2,
        "ac_active_power_01kW": 3,
        "bat_use": 1,
        "bat_status": 1,
        "bat_user_soc": 46
    },
    "direction": {
        "is_direct_consuming_": 1,
        "is_battery_charging_": 1,
        "is_battery_discharging_": 0,
        "is_grid_selling_": 0,
        "is_grid_buying_": 0,
        "is_charging_from_grid_": 0,
        "is_discharging_to_grid_": 0
    },
    "operation": {
        "status": "start",
        "mode": 1,
        "oper_status": 3,
        "simple_status": 1,
        "backup_mode": 1,
        "remote_mode": 0,
        "demo_mode": 0,
        "tou_period": 1,
        "ripple_control": "0",
        "ripple_level": "0"
    },
    "pcs_fault": {
        "pcs_status": "pcs_ok",
        "grid_fault": "0"
    },
    "heatpump": {
        "heatpump_protocol": "2",
        "heatpump_installed": "no",
        "heatpump_activate": "off",
        "current_temp": 0,
        "heatpump_working": "off"
    },
    "evcharger": {
        "ev_activate": "off",
        "ev_power": 0
    },
    "gridWaitingTime": 0,
    "coredump": "none",
    "factory_test_mode": "none"
}
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.