pyfibaro 0.8.3

Simple API to access fibaro home center from any Python 3 script. Designed for Home Assistant (but not only)

pyfibaro

This project has no relation to the fibaro company.

Simple API to access fibaro home center from Python 3. For more detailed information about the API see

Home center 2 / Home center lite

Home center 3 / Home center 3 lite / Yubii Home

The Zooz Z-Box Hub is powered as well by Software from Fibaro and supports currently the same API. This means that the pyfibaro library as well supports the Zooz Z-Box Hub (this support is untested as there is no public API documentation about the Zooz Z-Box Hub).

The pyfibaro library was created for integrating the fibaro home center with home assistant but can be used also in other projects.

Install

To install pyfibaro simply type

pip install pyfibaro

Authentication

All endpoints of the fibaro home center except info and login status needs an authenticated user. Just create a user in the fibaro home center with enough rights.

Development

Easiest way to start developing is to use Visual Studio Code + devcontainer.

Prerequisites

Docker

Visual Studio code

Getting started

1. Fork this repository
2. Enter the following link in your browser: vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=<your github repository url>
3. When Visual Studio Code asks if you want to install the Remote extension, click "Install".

For additional information about Visual Studio Code + devcontainer learn more about devcontainers.

Testing

Run the script

script/test

This will run all unit tests with code coverage enabled.

Usage

client = FibaroClient("http://192.168.1.2/api/")
client.set_authentication("your_fibaro_username", "your_fibaro_password")
client.connect()

devices = client.read_devices()
for device in devices:
    print(f"Device {device.fibaro_id}: {device.name}")

devices[10].execute_action("turnOn")

See folder examples for additional examples.