Fritz!Box p3exporter collector module
Project description
p3exporter collector module for FritzBox smarthome data
This module provides collector for FritzBox smarthome device data. It can be enabled with a default p3exporter installation via p3.yml
.
The collector is in a very early state and it provides temperature data from connected thermostat devices with temperature sensors.
Tested with:
- Comet DECT thermostat
Installation and Running
You need to install p3exporter
first. It is available on pypi so you can use pip
to install the exporter and run it locally.
pip install p3exporter
Now you need to install p3exporter-fritzbox-smarthome
. Choose one method mentioned below.
Install from pypi.org
Not yet available
Install from repository
You can install it from a local clone of our github repository.
$ git clone https://github.com/codeaffen/p3exporter-fritzbox-smarthome.git
Cloning into 'p3exporter-fritzbox-smarthome'...
...
$ cd p3exporter-fritzbox-smarthome
$ pip install -e .
Activation FritzBox smarthome collectors
To start p3exporter
you need a valid p3.yml
you can either edit an existing one or take the example from this repository.
cp p3.yml.example /tmp/p3.yml
If you edit an existing p3.yml
add the following content to activate the collector.
collectors:
- p3eFritzBox.collector.smarthome
collector_opts:
smarthome:
username: smarthome
password: v3rys3cr3t
After that you can start the p3exporter as usual:
$ p3exporter -c /tmp/p3.yml
INFO:root:Collector 'p3eFritzBox.collector.smarthome' was loaded and registred successfully
INFO:root:Start exporter, listen on 5876
Configuration
There are some parameters avaiable to configure the collector. In the following table all parameters are listed.
Name | Default | Mandatory | Description |
---|---|---|---|
username | * | Username used to authenticate against FritzBox | |
password | * | Password used to authenticate against FritzBox | |
hostname | https://fritz.box | Hostname of FritzBox to connect to. Protocol can be http or https . If no protocol is given default will be https . |
|
device_types | List of device type to enable. If List is empty all device types are activated. Possible values are:
|
||
ssl_verify | False | Set to True to disable ssl certificate verfication. This is useful in case of using self signed certificates.Note: To use this parameter pyfritzhome from github is needed as the ssl_verify parameter is not yet available in pypi package. For details use requirements.txt . |
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
Hashes for p3exporter-fritzbox-smarthome-1.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a90bdd31ac5da6df04c93a775aee905515d01016989b08474145dc3eb9f1a4ec |
|
MD5 | dca2723e9fb1ea39291ae5a670eb0673 |
|
BLAKE2b-256 | 21b92ec32b6688d20e4de6a0e31fe7d5cb99dd83e68d22a677cc9a7efea98228 |
Hashes for p3exporter_fritzbox_smarthome-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6ad7966bd191b5b3af98eed64fc694ee95324187ea9050423a2dafc752b1726 |
|
MD5 | c016f7cd005f0fc741b12ef9cd79475c |
|
BLAKE2b-256 | fbe4383cfbe8e34d10881e4fe3064938309eda948630de92f45f0f447bdf3a73 |