Skip to main content

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

Project description

pyfibaro

license

This project has no relation to the fibaro company.

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

Home center 2 / Home center lite

Home center 3 / Home center 3 lite / Yubii Home

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.

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

pyfibaro-0.6.4.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

pyfibaro-0.6.4-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file pyfibaro-0.6.4.tar.gz.

File metadata

  • Download URL: pyfibaro-0.6.4.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for pyfibaro-0.6.4.tar.gz
Algorithm Hash digest
SHA256 42812d715e49121db2b790cbb7854ceee00a095906d1a9ed1a073052d6a01921
MD5 01f7aca51aa3a883ae746b983d0456fa
BLAKE2b-256 56b34511962177b280712969e2f544a657c9afb30fa4bff0230b1618b4af0ed8

See more details on using hashes here.

File details

Details for the file pyfibaro-0.6.4-py3-none-any.whl.

File metadata

  • Download URL: pyfibaro-0.6.4-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for pyfibaro-0.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7ad0dcd871df8f3e356475286d21920cf4a03217f09c2f7e6031ed5c32531b3d
MD5 151652a045c1f39fb60c24c903b0a1ae
BLAKE2b-256 399848ddac5dd14a910bb0b5bbc160fb391cb5069dfaf79566ff2c1f125754c2

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