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

Uploaded Source

Built Distribution

pyfibaro-0.6.5-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfibaro-0.6.5.tar.gz
  • Upload date:
  • Size: 10.4 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.5.tar.gz
Algorithm Hash digest
SHA256 1adf7ae0b162b30a4dcc7d11c874adecc43d7e04fc8eb11b28ac54e3ea2e8e29
MD5 b0c0f25bf960c62de77253bfa89fa7e6
BLAKE2b-256 d4001debf6f293ad531946d06479a476937111da69508ded62d0cda7f5afeaa2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyfibaro-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 12.6 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c9967bb11bb8ddf37e5b8c2be7db3c2d89f8f4b53883b01237dbaf014da9bf67
MD5 2d5fca6c24b451c7283f9d275fe11a2b
BLAKE2b-256 433703f4d276e20caf778c881427a045047d9e2a1e777c06d2307d4bde3f3329

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