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 pypi package python version

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.7.3.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

pyfibaro-0.7.3-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyfibaro-0.7.3.tar.gz
Algorithm Hash digest
SHA256 a62359c982c7c7bc717fdb6c249ae08a063dc73fbd29b9484cf179c8d7fb7bab
MD5 349f972443d0b46ace88d6b5bbbd543a
BLAKE2b-256 e8ff280600b739d0e1271eb83f661294c67510dfbca69c11a355c96bf3f4bc1f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyfibaro-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 15124a199efbe3544e4b2688582ab0181fc6403169536144c530a801cb5a1bfe
MD5 82421fa512e17a3386309c660d12d92c
BLAKE2b-256 7463a6dbad79a155292417f9a30d5733ece5ecca55282c5967389574f6247791

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