Query information from your FRITZ!Box (mostly energy)
Project description
fritzbox-smarthome
==================
**(DE) Bitte beachten**: Diese Bibliothek wird nicht aktiv vom Autor weiterentwickelt, Pull Requests werden jedoch geprüft und eingepflegt.
**(EN) Please note:** This library is not in active development by the author, yet pull requests are reviewed and merged.
Python-Bibliothek um FRITZ!Box SmartHome-Geräte (DECT 200, PowerLine 546E, ...) zu steuern und die Energiewerte auszulesen.
Getestet mit:
* FRITZ!Box 7390 (Firmware 06.23, 06.50+)
* FRITZ!DECT 200
* FRITZ!Powerline 546E
Installation
------------
Es ist empfehlenswert, ein eigenes virtualenv zur Verwendung anzulegen. Unser macOS kann dieses Tool vorher mit `brew install virtualenv` installiert werden, unter Linux-Systemen hängt dies von der Distribution ab. Windows wird nicht offiziell unterstützt.
```
virtualenv ~/fritzenv
. ~/fritzenv/bin/activate
git clone https://github.com/DerMitch/fritzbox-smarthome.git
cd fritzbox-smarthome
pip install .
```
**Hinweis:** Das PyPi-Paket `fritzhome` wird nur selten aktualisiert, daher ist die Verwendung des git-Masters zu bevorzugen.
SmartHome-Benutzer
------------------
Aus Sicherheisgründen ist es empfehlenswert, einen eigenen Benutzer zum SmartHome-Zugriff zu verwenden. Dazu in der FRITZ!Box:
1. Die Benutzer-basierte Anmeldung aktivieren (unter "System" -> "FRITZ!Box Benutzer")
2. Und einen neuen Benutzer Benutzer "smarthome" erstellen. Dieser braucht nur Rechte auf den Bereich "Smart Home".
Verwendung
----------
Beispiele zur Verwendung der API befindet sich in der Datei `__main__.py`.
Nach der Installation steht das `fritzhome` Tool zur Verfügung, mit dem die Energiedaten auf der CLI angezeigt und nach Graphite exportiert werden können.
Befehle:
```
$ fritzhome [--server fritz.box] energy
PowerEingang (087600000000): 35.76 Watt current, 91.500 wH total
SmartHome Wohnzimmer (24:65:11:00:00:00): 56.21 Watt current, 1122.840 wH total
```
```
$ fritzhome [--server fritz.box] [switch-on|switch-off] 24:65:11:00:00:00
Switching SmartHome Wohnzimmer on
```
```
$ fritzhome [--server ip] graphite localhost [--port 2003] [--interval 10] [--prefix smarthome]
```
Aufruf außerhalb des virtualenv
-------------------------------
Das `fritzhome` kann mit Hilfe seines absoluten Pfades innerhalb des virtualenv ausgeführt werden:
```
~/fritzenv/bin/fritzhome --help
```
Referenzen
----------
* [AHA-HTTP-Interface](https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AHA-HTTP-Interface.pdf)
* [PHP AHA Reader](http://www.tdressler.net/ipsymcon/download/fritz_aha_reader2.phps)
==================
**(DE) Bitte beachten**: Diese Bibliothek wird nicht aktiv vom Autor weiterentwickelt, Pull Requests werden jedoch geprüft und eingepflegt.
**(EN) Please note:** This library is not in active development by the author, yet pull requests are reviewed and merged.
Python-Bibliothek um FRITZ!Box SmartHome-Geräte (DECT 200, PowerLine 546E, ...) zu steuern und die Energiewerte auszulesen.
Getestet mit:
* FRITZ!Box 7390 (Firmware 06.23, 06.50+)
* FRITZ!DECT 200
* FRITZ!Powerline 546E
Installation
------------
Es ist empfehlenswert, ein eigenes virtualenv zur Verwendung anzulegen. Unser macOS kann dieses Tool vorher mit `brew install virtualenv` installiert werden, unter Linux-Systemen hängt dies von der Distribution ab. Windows wird nicht offiziell unterstützt.
```
virtualenv ~/fritzenv
. ~/fritzenv/bin/activate
git clone https://github.com/DerMitch/fritzbox-smarthome.git
cd fritzbox-smarthome
pip install .
```
**Hinweis:** Das PyPi-Paket `fritzhome` wird nur selten aktualisiert, daher ist die Verwendung des git-Masters zu bevorzugen.
SmartHome-Benutzer
------------------
Aus Sicherheisgründen ist es empfehlenswert, einen eigenen Benutzer zum SmartHome-Zugriff zu verwenden. Dazu in der FRITZ!Box:
1. Die Benutzer-basierte Anmeldung aktivieren (unter "System" -> "FRITZ!Box Benutzer")
2. Und einen neuen Benutzer Benutzer "smarthome" erstellen. Dieser braucht nur Rechte auf den Bereich "Smart Home".
Verwendung
----------
Beispiele zur Verwendung der API befindet sich in der Datei `__main__.py`.
Nach der Installation steht das `fritzhome` Tool zur Verfügung, mit dem die Energiedaten auf der CLI angezeigt und nach Graphite exportiert werden können.
Befehle:
```
$ fritzhome [--server fritz.box] energy
PowerEingang (087600000000): 35.76 Watt current, 91.500 wH total
SmartHome Wohnzimmer (24:65:11:00:00:00): 56.21 Watt current, 1122.840 wH total
```
```
$ fritzhome [--server fritz.box] [switch-on|switch-off] 24:65:11:00:00:00
Switching SmartHome Wohnzimmer on
```
```
$ fritzhome [--server ip] graphite localhost [--port 2003] [--interval 10] [--prefix smarthome]
```
Aufruf außerhalb des virtualenv
-------------------------------
Das `fritzhome` kann mit Hilfe seines absoluten Pfades innerhalb des virtualenv ausgeführt werden:
```
~/fritzenv/bin/fritzhome --help
```
Referenzen
----------
* [AHA-HTTP-Interface](https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AHA-HTTP-Interface.pdf)
* [PHP AHA Reader](http://www.tdressler.net/ipsymcon/download/fritz_aha_reader2.phps)
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
fritzhome-1.0.5.tar.gz
(8.4 kB
view details)
Built Distribution
File details
Details for the file fritzhome-1.0.5.tar.gz
.
File metadata
- Download URL: fritzhome-1.0.5.tar.gz
- Upload date:
- Size: 8.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 08c20311ffb8f0592f91e17936247c80976cfb547ae14de44b98035d76c896df |
|
MD5 | c3447671e3faa135b1da9d54c579eaec |
|
BLAKE2b-256 | d018354a9cbc5dfb206215170a2811096c74257c095f8613b20766a5ba6b5402 |
File details
Details for the file fritzhome-1.0.5-py2.py3-none-any.whl
.
File metadata
- Download URL: fritzhome-1.0.5-py2.py3-none-any.whl
- Upload date:
- Size: 12.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 005ac3daa3303fa4a17d537c7de4a8569c09c7c1c6b6d01ba755241efe8ccbe7 |
|
MD5 | bb72b7a4d650914184e2213e6090bff9 |
|
BLAKE2b-256 | a2df3b6ca1555f075a4014c8866347bc2e882e88247b80a9725ba97ac32ff52d |