From 4c3c0b2c2714193affdaa4e57b085ee1c717b8ba Mon Sep 17 00:00:00 2001 From: thl-cmk <thl-cmk@outlook.com> Date: Tue, 9 Jan 2024 18:38:25 +0000 Subject: [PATCH] Update README.md --- README.md | 263 ++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 246 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c4ca544..77bcf2b 100644 --- a/README.md +++ b/README.md @@ -123,42 +123,271 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut --- ### Check Info -The plugin creates the service **_SERVICENAME_** for each discovered FOR WHAT with the **_HOW_TO_BUILD_THE_ITEM_** as item +<details><summary>fritzbox_smarthome.py</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> +<br> +Monitoring states + +| State | condition | WATO | +| ------ | ------ | ------ | +| WARN/CRIT | if the device is offline | yes | + + +<br> +Perfdata + +This plugin has no perfdata. + +<br> +WATO + +| Section | Rule name | +| ------ | ------ | +| Applications, Processes & Services | Fritz!Box Smarthome Devices | + +| Option | Defailt value | +| ------ | ------ | +| Monitoring state for offline devices | WARN | + +</details> + +<details><summary>fritzbox_smarthome_app_lock.py</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> +<br> +Monitoring states + +| State | condition | WATO | +| ------ | ------ | ------ | +| WARN/CRIT | if App lock is activated/deactivated | yes | + +<br> +Perfdata + +This plugin has no perfdata. + +<br> +WATO + +| Section | Rule name | +| ------ | ------ | +| Applications, Processes & Services | Fritz!Box Smarthome App Lock | + +| Option | Defailt value | +| ------ | ------ | +| Manual access for phone, app or user interface | Activated -> OK | -<details><summary>Montoring states</summary> + +</details> + +<details><summary>fritzbox_smarthome_battery.py</summary> +<br> +The plugin creates the service "Battery" for each discovered battery. In non pigyback mode the device ID is used as item. +<br> +<br> +Monitoring states + +| State | condition | WATO | +| ------ | ------ | ------ | +| WARN/CRIT | if the battery is low | yes | + +<br> +Perfdata + +This plugin has no perfdata. + +<br> +WATO + +| Section | Rule name | +| ------ | ------ | +| Applications, Processes & Services | Fritz!Box Smarthome Battery | + +| Option | Defailt value | +| ------ | ------ | +| Monitoring state on low battery | CRIT | + + +</details> + +<details><summary>fritzbox_smarthome_device_lock.py</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> +<br> +Monitoring states | State | condition | WATO | | ------ | ------ | ------ | -| WARN | condition 1 | yes | -| CRIT | condition 2 | no | -| WARN/CRIT | condition 3 | no | +| WARN/CRIT | if the bdevice lock is activated/deactivated | yes | + +<br> +Perfdata + +This plugin has no perfdata. + +<br> +WATO + +| Section | Rule name | +| ------ | ------ | +| Applications, Processes & Services | Fritz!Box Smarthome Device Lock | + +| Option | Defailt value | +| ------ | ------ | +| Button lock on the device | Activated -> OK | </details> -<details><summary>Perfdata</summary> +<details><summary>fritzbox_smarthome_power_meter.py</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> +<br> +Monitoring states + +| State | condition | WATO | +| ------ | ------ | ------ | +| WARN/CRIT | if energy outside upper/lower levels | yes | +| WARN/CRIT | if power above upper levels | yes | +| WARN/CRIT | if voltage outside upper/lower levels | yes | + +<br> +Perfdata | Metric | Unit | Perfometer | | ------ | ------ | ------ | -| METRIC 1 | bit/s | yes | -| METRIC 2 | C | yes | -| METRIC 3 | V | no | +| Cost this day | ¤ | yes | +| Cost this hour | ¤ | yes | +| Cost this month | ¤ | yes | +| Cost this year | ¤ | yes | +| Energy since last | Wh | yes | +| Energy Total | Wh | no | +| Time between readings | s | no | +| Power | W | yes | +| Voltage | V | yes | + +<br> +WATO + +| Section | Rule name | +| ------ | ------ | +| Applications, Processes & Services | Electrical Energy | + +| Option | Defailt value | +| ------ | ------ | +| Upper levels for electrical energy | no defaults | +| Lower levels for electrical energy | no defaults | +| Cost per kWh | 030€ | + +Note: Power and Voltage uses the build-in WATO rulsets (Electrical Power for Devices with only one phase / Voltage Sensor) </details> ---- -### WATO -<details><summary>Service monitoring rule</summary> + +<details><summary>fritzbox_smarthome_power_socket.py</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> +<br> +Monitoring states + +| State | condition | WATO | +| ------ | ------ | ------ | +| WARN/CRIT | if state on/off | yes | +| WARN/CRIT | if mode manuell/automatic | yes | + +<br> +Perfdata + +This plugin has no perfdata. + +<br> +WATO + +| Section | Rule name | +| ------ | ------ | +| Applications, Processes & Services | Fritz!Box Smarthome Power socket | + +| Option | Defailt value | +| ------ | ------ | +| Power Socket state | Switched on -> OK | +| Power Socket switching mode | Manuell -> OK | + +</details> + + +<details><summary>fritzbox_smarthome_temperature.py</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> +<br> +Monitoring states + +This plugin uses the build-in Temperature WARN/CRIT levels. + +<br> +Perfdata + +Temperature in °C + +<br> +WATO + +This plugin uses the build-in Temperature rule set. + + +</details> + + +<details><summary>fritzbox_smarthome_thermostat.py</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> +<br> +Monitoring states + +| State | condition | WATO | +| ------ | ------ | ------ | +| WARN/CRIT | if temperature deviates from target | yes | +| WARN/CRIT | if thermostat is off | yes | +| WARN/CRIT | on error | yes | + +<br> +Perfdata + +| Metric | Unit | Perfometer | +| ------ | ------ | ------ | +| Temperature current | °C | yes | +| Temperature target | °C | yes | +| Temperature comfort | °C | no | +| Temperature economic | °C | no | + +<br> +WATO | Section | Rule name | | ------ | ------ | -| Networking | NAME_OF_THE_RULE | +| Applications, Processes & Services | Fritz!Box Smarthome Thermostat | | Option | Defailt value | | ------ | ------ | -| OPTION 1 | 10/50| -| OPTION 2 | 70/90 | -| OPTION 3 | CHOICE 1 | -| OPTION 4 | disabled | +| Deviation from target temperature | 2°C/5°C | +| Monitoring state if thermostat is off | OK | +| Monitoring state on error | WARN | + +</details> + + + +--- +### WATO +<details><summary>Service monitoring rules</summary> + +see Check Info </details> -- GitLab