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

Uploaded Source

Built Distribution

pyfibaro-0.7.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyfibaro-0.7.1.tar.gz
Algorithm Hash digest
SHA256 2a775e7bf387c173d431c19100e94157f743d05adcb3d69d536558dff2e4a80b
MD5 8892e6ad655c8cb1cf41d55f730dc59b
BLAKE2b-256 88529f03fb8659d958bde3f96885f95c6db5f682999bf0225480028299acb7d1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyfibaro-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 93b30acdb1e144e1f41768568d0a338157a8d5fc089f558c9198cda5ffd06baa
MD5 7c16d80da3a2b0ec506f0a7197e30c5c
BLAKE2b-256 774bc125296fa1a4abb3337f4086ba670eb7d050075a275eef89612cfa6d6dd8

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