Collection of CheckMK checks (see https://checkmk.com/). All checks and plugins are provided as is. Absolutely no warranty. Send any comments to thl-cmk[at]outlook[dot]com

Skip to content
Snippets Groups Projects
Commit abae3940 authored by thl-cmk's avatar thl-cmk :flag_na:
Browse files

Update README.md

parent 97338895
No related branches found
No related tags found
No related merge requests found
[PACKAGE]: ../../raw/master/mkp/fritzbox_smarthome-0.8.2-20231230.mkp "fritzbox_smarthome-0.8.2-20231230.mkp"
# AVM Fritz!Box Smarthome
This repository contains a additional check_MK Fritz!Box Agent which can gather informations over the AVM AHA HTTP Interface about SmartHome Devices connected to an Fritz!Box. In the first version this was a modification this was a modification of the normal checkmk fritzbox agent now it is seperated from it.
It also provides a Check for parsing the output, and WATO-Pages for configuring thresholds.
This repository contains a additional check_MK Fritz!Box Agent which can gather informations over the AVM AHA HTTP Interface about SmartHome Devices connected to an Fritz!Box.
This package contains the folloeing plugins
<details><summary>agent_fritzbox_smarthome.py</summary>
The actual agent
</details>
<details><summary></summary>
This package is based on the work of Maximilian Clemens [(see Acknowledgements)](#acknowledgements). I have rewritten this package for use with CMK 2.2.0x. As I do not have access to all Smarthome devices, I have only implemented the checks for the following devices:
</details>
- agent_fritzbox_smarthome.py
- fritzbox_smarthome.py
- fritzbox_smarthome_app_lock.py
- fritzbox_smarthome_battery.py
- fritzbox_smarthome_device_lock.py
- fritzbox_smarthome_power_meter.py
- fritzbox_smarthome_power_socket.py
- fritzbox_smarthome_switch.py
- fritzbox_smarthome_temperature.py
- fritzbox_smarthome_thermostat.py
- inv_fritzbox_smarthome.py
- FRITZ!DECT Repeater 100
- FRITZ!DECT 200
- FRITZ!DECT 302
So if you want the package to be extended to support your sensors as well, see [Want to Contribute?](#want-to-contribute) Also, my FRIT!BOX is not brand new, so it may not include all the features that the Smnarthome devices support. E.g. window open/close for the FRITZ!DECT 302.
---
### Acknowledgment
### Acknowledgments
This packages is based on the werk by [MaximilianClemens](https://github.com/MaximilianClemens) see [checkmk_fritzbox on GitHub](https://github.com/MaximilianClemens/checkmk_fritzbox)
---
### Packages contents
This package contains the follwing plugins:
- agent_fritzbox_smarthome.py: the actual agent
- fritzbox_smarthome.py: the base chaeck plugin
- fritzbox_smarthome_app_lock.py: shows if the device can be acssed by App, Phone or UI
- fritzbox_smarthome_battery.py: shows the the battery state
- fritzbox_smarthome_device_lock.py: shows if the button on the device are locked or not
- fritzbox_smarthome_power_meter.py: shows voltage, electrical power and electrical eneregy
- fritzbox_smarthome_power_socket.py: shows the status os a switchable power socket
- fritzbox_smarthome_switch.py: shows the status of a simple switch
- fritzbox_smarthome_temperature.py: shows the temeprature and offset of a themperature sensor
- fritzbox_smarthome_thermostat.py: shows the working states of a thermostat (radiator controller)
- inv_fritzbox_smarthome.py
---
### Usage
**Note**: Before using this agent, please make sure that the names of your smart home devices are compatible with CMK.
CMK only allows `.-_a-zA-Z0-9`. If your devices do not follow this pattern, the agent replaces ` ` (space) with `_` and removes all other non-allowed characters from the host names.
After installing the package, create a new WATO rule **Setup -> Other integrations -> Fritz!Box Smarthome devices**.
Here you need at least the user name and password to log in to your Fritz!Box For the password, I recommend using the CMK password store. The agent uses HTTPS on port TCP/443 by default and checks the certificate of your Fritz!Box, so if you do not have a good certificate, activate the option `Ignore SSL errors`. Don't forget to use your Fritz!Box as a condition with **Explicit hosts**.
By default, the agent uses the CMK piggyback mechanism for the Smarthome devices. Depending on your CMK edition, you therefore have two options for adding these hosts. In the _RAW_ edition, you create them like any other host object (by hand, CSV, API). Set the following fields:
- IP address family -> No IP
- Checkmk agent / API integrations -> No API integration, no Checkmk agent
- SNMP -> no SNMP
- Piggyback -> Always use and expect piggyback data
In all othe editions you can use the Dynamic host management (DCD) to do this job for you. See _Setup_ -> _Dynamic host management_.
Now you are ready to let CMK find your Smarthomne devices.
```
OMD[build]:~$ ~/local/share/check_mk/agents/special/agent_fritzbox_smarthome --help
usage: agent_fritzbox_smarthome [-h] [--debug] [--ignore_ssl] [--no-piggyback] [--password [PASSWORD]]
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment