# Fronius Solar API V1

Source: https://docs.evcc.io/en/meters/fronius-solar-api-v1

Solar API should only be used as fallback. Integration via Modbus is preferred.

Username and password are only required for active battery control.

**Attention**: Active battery control should only be used if no other settings for time-dependent battery control were made in the inverter configuration under "Energy Management" - "Battery Management", as existing settings will be overwritten. Choose corresponding configuration URI!

Supported features: battery-control

## Parameters

| Name | Description | Default / example | |
| --- | --- | --- | --- |
| host | IP address or hostname | 192.0.2.2 |  |
| user | Username (for active battery control) e.g. email address, user id, etc. | customer |  |
| password | Password (for active battery control) Service account password |  |  |
| capacity | Battery capacity | 50 kWh |  |
| minsoc | Minimum charge Lower limit as configured on the battery system. Used by optimizer. | 0 % |  |
| maxsoc | Maximum charge Upper limit as configured on the battery system. Used by optimizer and for grid charging. | 100 % |  |
| batteryconfiguri | Battery configuration URI Firmware starting with 1.36.5-1 requires /api/config. (/config, /api/config) | /config | advanced |
| maxchargepower | Maximum charge power For forced charging of the battery. |  W | advanced |
| maxdischargepower | Maximum discharge power Maximum discharge power of the storage. |  W | advanced |
| cache | Cache Time interval for data refresh | 1s | advanced |

## Configuration example for evcc.yaml

```yaml
meters:
    - name: my_grid
      type: template
      template: fronius-solarapi-v1
      usage: grid
      host: 192.0.2.2 # IP address or hostname
      user: customer # Username (for active battery control), e.g. email address, user id, etc. (optional)
      password: # Password (for active battery control), Service account password (optional)
      batteryconfiguri: /config # Battery configuration URI, Firmware starting with 1.36.5-1 requires /api/config. [/config, /api/config] (optional)
      cache: 1s # Cache, Time interval for data refresh (optional)
```

```yaml
meters:
    - name: my_pv
      type: template
      template: fronius-solarapi-v1
      usage: pv
      host: 192.0.2.2 # IP address or hostname
      user: customer # Username (for active battery control), e.g. email address, user id, etc. (optional)
      password: # Password (for active battery control), Service account password (optional)
      batteryconfiguri: /config # Battery configuration URI, Firmware starting with 1.36.5-1 requires /api/config. [/config, /api/config] (optional)
      cache: 1s # Cache, Time interval for data refresh (optional)
```

```yaml
meters:
    - name: my_battery
      type: template
      template: fronius-solarapi-v1
      usage: battery
      host: 192.0.2.2 # IP address or hostname
      user: customer # Username (for active battery control), e.g. email address, user id, etc. (optional)
      password: # Password (for active battery control), Service account password (optional)
      capacity: 50 # Battery capacity (kWh), optional
      minsoc: 0 # Minimum charge (%), Lower limit as configured on the battery system. Used by optimizer. (optional)
      maxsoc: 100 # Maximum charge (%), Upper limit as configured on the battery system. Used by optimizer and for grid charging. (optional)
      batteryconfiguri: /config # Battery configuration URI, Firmware starting with 1.36.5-1 requires /api/config. [/config, /api/config] (optional)
      maxchargepower: # Maximum charge power (W), For forced charging of the battery. (optional)
      maxdischargepower: # Maximum discharge power (W), Maximum discharge power of the storage. (optional)
      cache: 1s # Cache, Time interval for data refresh (optional)
```