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 4c3c0b2c authored by thl-cmk's avatar thl-cmk :flag_na:
Browse files

Update README.md

parent 397b4ab5
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 246 additions and 17 deletions
README.md
+ 246
− 17
View file @ 4c3c0b2c
...@@ -123,42 +123,271 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut ...@@ -123,42 +123,271 @@ Nice ;-) Have a look at the [contribution guidelines](CONTRIBUTING.md "Contribut
--- ---
### Check Info ### 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 | | State | condition | WATO |
| ------ | ------ | ------ | | ------ | ------ | ------ |
| WARN | condition 1 | yes | | WARN/CRIT | if the bdevice lock is activated/deactivated | yes |
| CRIT | condition 2 | no |
| WARN/CRIT | condition 3 | no | <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>
<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 | Unit | Perfometer |
| ------ | ------ | ------ | | ------ | ------ | ------ |
| METRIC 1 | bit/s | yes | | Cost this day | ¤ | yes |
| METRIC 2 | C | yes | | Cost this hour | ¤ | yes |
| METRIC 3 | V | no | | 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> </details>
---
### WATO <details><summary>fritzbox_smarthome_power_socket.py</summary>
<details><summary>Service monitoring rule</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 | | Section | Rule name |
| ------ | ------ | | ------ | ------ |
| Networking | NAME_OF_THE_RULE | | Applications, Processes & Services | Fritz!Box Smarthome Thermostat |
| Option | Defailt value | | Option | Defailt value |
| ------ | ------ | | ------ | ------ |
| OPTION 1 | 10/50| | Deviation from target temperature | 2°C/5°C |
| OPTION 2 | 70/90 | | Monitoring state if thermostat is off | OK |
| OPTION 3 | CHOICE 1 | | Monitoring state on error | WARN |
| OPTION 4 | disabled |
</details>
---
### WATO
<details><summary>Service monitoring rules</summary>
see Check Info
</details> </details>
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

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