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

Uploaded Source

Built Distribution

pyfibaro-0.6.1-py3-none-any.whl (10.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyfibaro-0.6.1.tar.gz
  • Upload date:
  • Size: 8.3 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.1.tar.gz
Algorithm Hash digest
SHA256 6ea6e181046804b758b4314e3396c71cb7dcf8134a514e281142f1ddb932c803
MD5 e25ec859a99b4f795562de4b9d70f3f7
BLAKE2b-256 b677398a57cc2ae74850e0cf22a60a346f71b65401b908d8c402b80e9eba6d88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyfibaro-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 10.4 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 efd366c9b02a87bf26bb6ea278f430f9da11a30d5413b80fd2064e8e711778ef
MD5 999b55dfb9d71477e03ad3004e9068bc
BLAKE2b-256 9d5c1999d76c46950583feb4763eedb33450c0bb012216207748af99def7c7fa

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