Skip to main content

Access to AVM Home Automation with Robot Framework

Project description

Build Status

Robot Framework FritzHome Library

A Robot Framework Library to access the AVM Home Automation HTTP Interface.

With this Library Robot Test Cases and Robot Tasks can retrieve measured values from and send commands to the DECT Devices connected to a fritzbox, such as toggle switches or getting temperature from radiator control.

See also the file example.robot for example robot tasks.

Installation

Not published on PyPI now, but when this is done, use:

$ pip install robotframework-fritzhomelibrary

Import

Importing this library into a Robot Test Suite or Robot Task:

| *** Settings ***    |
| Library             | FritzHome

Opening and Closing a Session

To use the keywords of this library, first a session must be opened.

| *** Task *** |
| Open Session | ${password} | ${user} | ${url} |

User and URL have default values (admin and http://fritz.box)

A connection to the fritzbox is established, and, if authentication succeeds, a session is created. The library handles the technical part (session id, AIN, ...) in the background. Devices are identified just by their names, for example:

| Set Switch State | my first switch | On |

Close the session with the Close Session keyword.

Naming Devices

Most device specific keywords of this library take the name of the device to identify it. The name is given over the fritzbox web interface (Home Network / Smart Home / All smart home devices). It is possible to use spaces, umlauts and special characters (for instance you can name your device ◄▬┼ Übungsgerät :-) ┼▬►), because both, Robot Framework and the operatingsystem of the fritzbox seems to be tolerant with such characters.

Internally devices are identified by their AIN. If it becomes necessary to use an AIN in a robot test case or robot task, use the keyword Get AIN.

Temperature Units

The keywords to get the temperature measured by a device will return the value in Degree Celsius (°C) by default. With the unit parameter it is possible to get the value in Degree Fahrenheit (°F) or Kelvin (K) instead.

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

Built Distribution

File details

Details for the file robotframework-fritzhomelibrary-1.3.0.tar.gz.

File metadata

  • Download URL: robotframework-fritzhomelibrary-1.3.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for robotframework-fritzhomelibrary-1.3.0.tar.gz
Algorithm Hash digest
SHA256 55f6f213f4c4c1c33a0657dcbe0f03388659f3b834f12c26791f4385d05520fc
MD5 d9bfa79fae5c9a9d39285ce754da7cc5
BLAKE2b-256 637da822bea760617384a7ae6a286ca135aa514f0b6f9edd13f38743eb02a823

See more details on using hashes here.

File details

Details for the file robotframework_fritzhomelibrary-1.3.0-py3-none-any.whl.

File metadata

  • Download URL: robotframework_fritzhomelibrary-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

File hashes

Hashes for robotframework_fritzhomelibrary-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 921e918595698c0d90840227e59f1c53b1b3369557a649deaed64c4d219184c3
MD5 1c9c4b20c4b091d82898fe046aebccea
BLAKE2b-256 b0c76246054021091ece56269d9658e168bb56169cb35c2fe115a4adb415d397

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