Skip to main content

Wiser by Feller µGateway API

Project description

Wiser by Feller API Async Python Library

aioWiserbyfeller codecov PyPI - Version GitHub License

A modern async Python library to control and integrate Wiser by Feller smart light switches, cover controls, and scene buttons, hvac controls and weather stations into your Python applications.

[!IMPORTANT] This integration implements Wiser by Feller and not Wiser by Schneider Electric, which is a competing Smart Home platform (and is not compatible). It is even more confusing, as Feller (the company) is a local subsidiary of Schneider Electric, catering only to the Swiss market.

📦 Installation

pip install aiowiserbyfeller

🧑‍💻 Usage

import asyncio
import aiohttp
from aiowiserbyfeller import Auth, WiserByFellerAPI

async def main():
    async with aiohttp.ClientSession() as session:
        auth = Auth(session, "192.168.0.42")  # Replace with the IP of your µGateway
        api = WiserByFellerAPI(auth)
        info = await api.async_get_info()
        print(info)

asyncio.run(main())

🧰 Basic Functionality

Wiser by Feller devices (except hvac controllers and weather stations) consist of two parts: The control front and the base module. There are switching base modules (for light switches and cover controllers) and non-switching base modules (for scene buttons and secondary controls).

Because the functionality changes when the same base module is used with a different front, the combination of the two is considered an unique device.

Devices are connected with each other by a proprietary K+ bus system. One (and only one) device acts as a WLAN gateway (called µGateway) to interface with the system.

Learn more about Wiser devices on the official website and API documentation.

🚀 Features

Here's what this library offers:

✨ Easy to use framework

The library abstracts API functionality and allows for easy authentication, interaction with devices and data validation. Work with device classes, allowing for strongly typed implementations. Helper methods and properties abstract as much complexity of the API as possible, while retaining full flexibility.

🚨 Status LEDs

Each front features a configurable RGB LED edge for their buttons, that you would normally configure in the Wiser Home app. They can be configured in color and brightness. For buttons controlling a load, there can be two different brightnesses: One for if the load is on and one for if it is off. For others (e.g. scene buttons) there can only be one brightness, as there is no logical "on" state.

The library offers an intuitive way to update status LEDs without the need for complex back and forth with the API, allowing you to use them to represent other information than just the device state (e.g. completion of the washing machine program or motion in another room).

[!IMPORTANT] Due to the implementation on the devices, the status light is not suited for fast updating, as multiple slow API calls are necessary.

🔌 WebSockets

The µGateway offers a Websocket connection, allowing for instant updates about state changes. This library offers a convenient way to establish a connection and tap into the update notifications.

🧪 Robust test suite

Extensive unit test coverage ensures high stability and confidence even if new functionality is added.

⚠️ Known Limitations

  • The µGateway supports REST and WebSockets only. MQTT exists but is not publicly accessible.
  • Device names appear in German only, due to limited international support.
  • Status LED updates are slow, as they require multiple API calls.

🔗 Related Projects

🤝 Contributing

We welcome contributions! To get started:

  1. Create a virtual environment: python -m venv .venv
  2. Install dependencies: pip install ".[test]"
  3. Make your changes.
  4. Write or update unit tests.
  5. Run tests with pytest
  6. Open a Pull Request 🎉

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

aiowiserbyfeller-1.0.0b16.tar.gz (51.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiowiserbyfeller-1.0.0b16-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file aiowiserbyfeller-1.0.0b16.tar.gz.

File metadata

  • Download URL: aiowiserbyfeller-1.0.0b16.tar.gz
  • Upload date:
  • Size: 51.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for aiowiserbyfeller-1.0.0b16.tar.gz
Algorithm Hash digest
SHA256 2a002fab75ff10cf300f533b532afefbc722d32cc5a7fa2f34f9c9233887843f
MD5 66c5582ff3b8a6b477196632c8c3bdbf
BLAKE2b-256 ed005a6d1779dfb6b1403459b2026a2977f2f94553ebd3f4af9f7470ca90dfad

See more details on using hashes here.

File details

Details for the file aiowiserbyfeller-1.0.0b16-py3-none-any.whl.

File metadata

File hashes

Hashes for aiowiserbyfeller-1.0.0b16-py3-none-any.whl
Algorithm Hash digest
SHA256 e5b7dcc954a2641dcd846e31a1fe6d734935f846e1e8af772cb40be9e6cd5f4c
MD5 6ebcf1c71b5a053034d71ab8a15e5279
BLAKE2b-256 5a22d0c0ae0114e7aa3f336f46ad6519f26ce3f8f38c56ed97998fc2d8a0e793

See more details on using hashes here.

Supported by

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