Skip to main content

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.

Metadata

Release files for robotframework-fritzhomelibrary 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for robotframework-fritzhomelibrary 1.3.0
File Size Uploaded
robotframework-fritzhomelibrary-1.3.0.tar.gz 6.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for robotframework-fritzhomelibrary 1.3.0
File Interpreter ABI Platform
robotframework_fritzhomelibrary-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 14.2 kB

Release files / robotframework-fritzhomelibrary-1.3.0.tar.gz

Download URL robotframework-fritzhomelibrary-1.3.0.tar.gz
Size 6.5 kB
Tags Source
SHA-256 checksum
How to use checksums
55f6f213f4c4c1c33a0657dcbe0f03388659f3b834f12c26791f4385d05520fc
BLAKE2b-256 checksum
How to use checksums
637da822bea760617384a7ae6a286ca135aa514f0b6f9edd13f38743eb02a823
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / robotframework_fritzhomelibrary-1.3.0-py3-none-any.whl

Download URL robotframework_fritzhomelibrary-1.3.0-py3-none-any.whl
Size 7.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
921e918595698c0d90840227e59f1c53b1b3369557a649deaed64c4d219184c3
BLAKE2b-256 checksum
How to use checksums
b0c76246054021091ece56269d9658e168bb56169cb35c2fe115a4adb415d397
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page