diff --git a/README.md b/README.md index 77bcf2b153393f76d2b38ede22f0538d22458712..ef1f7157a6ee69dee91f60c1c262d94a081dc651 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,35 @@ This repository contains a additional check_MK Fritz!Box Agent which can gather 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: -- FRITZ!DECT Repeater 100 -- FRITZ!DECT 200 -- FRITZ!DECT 302 +<details><summary>FRITZ!DECT Repeater 100</summary> + +- Device Status +- Temperature + +</details> +<details><summary>FRITZ!DECT 200</summary> + +- App lock +- Device lock +- Device status +- Energy +- Power +- Power socket +- Switch +- Temperature +- Voltage + +</details> +<details><summary>FRITZ!DECT 302</summary> + +- App lock +- Battery +- Device Lock +- Device status +- Temperature +- Thermostat + +</details> So if you want the package to be extended to support your sensors as well, see [Want to Contribute?](CONTRIBUTING.md) 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. @@ -22,19 +48,19 @@ This packages is based on the werk by [MaximilianClemens](https://github.com/Max <details><summary>This package contains the follwing plugins</summary> -| File | Description | -| ------ | ------ | -| 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 of a switchable power socket | -| fritzbox_smarthome_switch.py | shows the status of a simple switch (on/off) | -| 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 | adds the smarthome devices to the CMK HW/SW inventory | +| Service | File | Description | +| ------ | ------ | ------ | +| N/A | agent_fritzbox_smarthome.py | the actual agent | +| Device status | fritzbox_smarthome.py | the base check plugin | +| App lock | fritzbox_smarthome_app_lock.py | shows if the device can be accessed by App, Phone or UI | +| Battery | fritzbox_smarthome_battery.py | shows the the battery state | +| Device Lock | fritzbox_smarthome_device_lock.py | shows if the buttons on the device are locked or not | +| Energy, Power, Voltage | fritzbox_smarthome_power_meter.py | shows electrical energy, electrical power and voltage | +| Power Socket | fritzbox_smarthome_power_socket.py | shows the status of a switchable power socket | +| Switch | fritzbox_smarthome_switch.py | shows the status of a simple switch (on/off) | +| Temperature | fritzbox_smarthome_temperature.py | shows the temperature and offset of a temperature sensor | +| Thermostat | fritzbox_smarthome_thermostat.py | shows the working states of a thermostat (radiator controller) | +| N/A | inv_fritzbox_smarthome.py | adds the smarthome devices to the CMK HW/SW inventory | </details> @@ -42,7 +68,7 @@ This packages is based on the werk by [MaximilianClemens](https://github.com/Max ### Usage <details><summary>How to configure the agent</summary> - +<br> **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. @@ -62,6 +88,7 @@ Now you are ready to let CMK find your Smarthomne devices. </details> <details><summary>Command Line help</summary> +<br> This is the Help txt from the agent. ``` @@ -102,7 +129,7 @@ options: ### Download * [Download latest mkp file][PACKAGE] -**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There migth be incompatible changes. +**Note**: before you update to a newer version, always check the [CHANGELOG](CHANGELOG). There might be incompatible changes. --- ### Installation @@ -123,7 +150,7 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut --- ### Check Info -<details><summary>fritzbox_smarthome.py</summary> +<details><summary>Device status</summary> <br> The plugin creates the services "Device status" for each discovered device. In non pigyback mode the device ID is used as item. <br> @@ -153,7 +180,7 @@ WATO </details> -<details><summary>fritzbox_smarthome_app_lock.py</summary> +<details><summary>App lock</summary> <br> The plugin creates the service "APP lock" for each discovered device. In non pigyback mode the device ID is used as item. <br> @@ -183,7 +210,7 @@ WATO </details> -<details><summary>fritzbox_smarthome_battery.py</summary> +<details><summary>Battery</summary> <br> The plugin creates the service "Battery" for each discovered battery. In non pigyback mode the device ID is used as item. <br> @@ -213,7 +240,7 @@ WATO </details> -<details><summary>fritzbox_smarthome_device_lock.py</summary> +<details><summary>Device lock</summary> <br> The plugin creates the service "Device lock" for each discovered device. In non pigyback mode the device ID is used as item. <br> @@ -242,7 +269,7 @@ WATO </details> -<details><summary>fritzbox_smarthome_power_meter.py</summary> +<details><summary>Energy, Power and Voltage</summary> <br> The plugin creates the services "Energy", "Power" and "Voltage" for each discovered device. In non pigyback mode the device ID is used as item. <br> @@ -288,7 +315,7 @@ Note: Power and Voltage uses the build-in WATO rulsets (Electrical Power for Dev </details> -<details><summary>fritzbox_smarthome_power_socket.py</summary> +<details><summary>Power socket</summary> <br> The plugin creates the service "Power Socket" for each discovered device. In non pigyback mode the device ID is used as item. <br> @@ -320,7 +347,7 @@ WATO </details> -<details><summary>fritzbox_smarthome_temperature.py</summary> +<details><summary>Temperature</summary> <br> The plugin creates the service "Temperature" for each discovered temperature sensor. In non pigyback mode the device ID is used as item. <br> @@ -343,7 +370,7 @@ This plugin uses the build-in Temperature rule set. </details> -<details><summary>fritzbox_smarthome_thermostat.py</summary> +<details><summary>Thermostat</summary> <br> The plugin creates the service "Thermostat" for each discovered device with thermostat function. In non pigyback mode the device ID is used as item. <br> @@ -381,8 +408,6 @@ WATO </details> - - --- ### WATO <details><summary>Service monitoring rules</summary>