Skip to main content

Unofficial, local Solarfocus client

Project description

pysolarfocus: Python Client for Solarfocus ecomanager-touch

Python client library to interact with heating systems of Solarfocus (ecomanager-touch and therminator II) via Modbus TCP. This library has been developed for the integration into Home-Assistant via a custom integration, but can be used indepdently.

What's Supported

Software Version

This integration has been tested with Solarfocus ecomanager-touch version 23.020.

Systems

  • Heat pump vampair with ecomanager-touch
  • Biomass boiler therminator II

Components

Components Supported
Heating Circuits (Heizkreis) 1-8 :white_check_mark:
Buffers (Puffer) 1-4 :white_check_mark:
Solar (Solar) :white_check_mark:
Boilers (Boiler) 1-4 :white_check_mark:
Heatpump (Wärmepumpe) :white_check_mark:
Biomassboiler (Kessel) :white_check_mark:
Fresh Water Module (Frishwasser Modul) 1-4 :white_check_mark:

How To

Basic Example

from pysolarfocus import SolarfocusAPI,Systems

# Create the Solarfocus API client
solarfocus = SolarfocusAPI(ip="[Your-IP]",system=Systems.Vampair)
# Connect to the heating system
solarfocus.connect() 
# Fetch the values
solarfocus.update()

# Print the values
print(solarfocus.buffers[0])
print(solarfocus.heating_circuit[0])

Handling multiple components e.g. heating circuits

Solarfocus systems allow the use of multiple heating circuits, buffers and boilers. The api can be configured to interact with multiple components.

# Create the Solarfocus API client with 2 Heating Circuits
solarfocus = SolarfocusAPI(ip="[Your-IP]",heating_circuit_count=2,system=Systems.Vampair)
# Connect to the heating system
solarfocus.connect()

# Update all heating circuits
solarfocus.update_heating()

# Update only the first heating circuit
solarfocus.heating_circuits[0].update()
# Print the first heating circuit
print(solarfocus.heating_circuits[0])

# Set the temperature of the first heating circuit to 30°C
solarfocus.heating_circuits[0].indoor_temperatur_external.set_unscaled_value(30)
# Write the value to the heating system
solarfocus.heating_circuits[0].indoor_temperatur_external.commit()

API-Version specification

By default, the integration uses API-Version21.140. If your system is newer, you can specify the version by using the api_version parameter.

solarfocus = SolarfocusAPI(ip="[Your-IP]", system=Systems.Vampair, api_version=ApiVersions.V_23_010)

Changelog of API-Versions

Note The API-Version of Solarfocus is independent of the versions of this library. Below list refers to to the Solarfocus versions. See releasesfor the changelog of this library.

23.020

  • Add fresh water module state.

23.010

  • Add biomass boiler pellet statistics.

22.090

  • Add biomass boiler sweep function control.
  • Allow input of external buffer values.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysolarfocus-3.6.2.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

pysolarfocus-3.6.2-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

Details for the file pysolarfocus-3.6.2.tar.gz.

File metadata

  • Download URL: pysolarfocus-3.6.2.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pysolarfocus-3.6.2.tar.gz
Algorithm Hash digest
SHA256 81af1c433ee8a0b95f5de2c446c591ef0f2937a1500df43265b564d3cbd59e3b
MD5 037f1806eafcdbedf89837fad1fe8844
BLAKE2b-256 0df5e5a7df0e4f17be7eadf82cb85550d38dfaa007967d19e72b65be3dd66772

See more details on using hashes here.

File details

Details for the file pysolarfocus-3.6.2-py3-none-any.whl.

File metadata

  • Download URL: pysolarfocus-3.6.2-py3-none-any.whl
  • Upload date:
  • Size: 25.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pysolarfocus-3.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 754255b7b85ba7d3f525358b1c71f16b23a3813642b75a8de79fd42029c7e1c5
MD5 0d3699418da7bd232f2a163e23bed83d
BLAKE2b-256 64d30b0e5c6ec4177da910c89db5502cdf9babd060bf9687318c1ba8db411647

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page