froeling-connect

An unofficial asynchronous Python library for interacting with the proprietary Fröling Connect web API.

⚠️ This library was primarily tested with the T4e Boiler. It may not work reliably with other models.

This project is not affiliated with Fröling Heizkessel- und Behälterbau Ges.m.b.H..
This library is provided "as is" and comes with no warranty. Use at your own risk. The author is not responsible for any damages, including but not limited to equipment damage, fire, water damage, or data loss, resulting from the use of this software.

Features

• Read notifications from Fröling Connect
• Retrieve general information about facilities and components
• Get and set parameters for components (partial support; not all parameters tested)
• Fully asynchronous API calls

Installation

pip install froeling-connect

Terminology

Usage

Currently, there is no detailed documentation. You can see a working example here.

A tiny snippet to showcase some features:

import asyncio
from froeling import Froeling

async def main():
    async with Froeling("username", "password") as api:
        facilities = await api.get_facilities()
        for facility in facilities:
            print(facility)

asyncio.run(main())

Notes

• The API is not public, so breaking changes on Fröling's end may occur without notice.
• This Project is still in beta; breaking changes are to be expected, though I try to minimize them.
• Contributions and bug reports are welcome.

Contributing

1. Fork the repository
2. Create a feature branch feature/[your-feature], branching off from main
3. Submit a pull request to main with your improvements

This project uses Hatch.

hatch fmt # Run linter and format code
hatch run dev:mypy src # Run mypy type checks
hatch test # Run tests (-a for all python versions)

License

Apache License