Skip to content

Commit 4d38ca7

Browse files
jayme-githubjayme-github
committed
Update metrics in README
1 parent a5f4ad7 commit 4d38ca7

File tree

1 file changed

+39
-24
lines changed

1 file changed

+39
-24
lines changed

‎README.md

Lines changed: 39 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -22,61 +22,76 @@ Command line arguments or environment variables (the argument as uppercase, like
2222
The exporter will bind to TCP Port 9103 and export the following metrics via `/metrics`:
2323

2424
```
25+
# HELP fritzbox_battery_charge_level Battery charge level in percent
26+
# TYPE fritzbox_battery_charge_level gauge
27+
fritzbox_battery_charge_level{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 70
28+
fritzbox_battery_charge_level{device_id="12345 0000007",device_name="BUTTON_1",device_type="FRITZ!DECT 440"} 100
29+
# HELP fritzbox_batterylow 0 if the battery is OK, 1 if it is running low on capacity (this seems to be very unreliable)
30+
# TYPE fritzbox_batterylow gauge
31+
fritzbox_batterylow{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 0
32+
fritzbox_batterylow{device_id="12345 0000007",device_name="BUTTON_1",device_type="FRITZ!DECT 440"} 0
2533
# HELP fritzbox_device_info Device information
2634
# TYPE fritzbox_device_info gauge
27-
fritzbox_device_info{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200",functionbitmask="2944",fw_version="03.87",internal_id="16",manufacturer="AVM"} 1
28-
fritzbox_device_info{device_id="12345 0000000",device_name="HKR 1",device_type="Comet DECT",functionbitmask="320",fw_version="03.68",internal_id="23",manufacturer="AVM"} 1
35+
fritzbox_device_info{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200",functionbitmask="35712",fw_version="04.16",internal_id="16",manufacturer="AVM"} 1
36+
fritzbox_device_info{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT",functionbitmask="320",fw_version="03.54",internal_id="21",manufacturer="AVM"} 1
37+
fritzbox_device_info{device_id="12345 0000007",device_name="BUTTON_1",device_type="FRITZ!DECT 440",functionbitmask="1048864",fw_version="05.21",internal_id="26",manufacturer="AVM"} 1
2938
# HELP fritzbox_device_present Device connected (1) or not (0)
3039
# TYPE fritzbox_device_present gauge
31-
fritzbox_device_present{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} 1
32-
fritzbox_device_present{device_id="12345 0000000",device_name="HKR 1",device_type="Comet DECT"} 1
33-
# HELP fritzbox_energy Absolute energy consumption since the device started operating
40+
fritzbox_device_present{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 1
41+
fritzbox_device_present{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 1
42+
fritzbox_device_present{device_id="12345 0000007",device_name="BUTTON_1",device_type="FRITZ!DECT 440"} 1
43+
# HELP fritzbox_energy Absolute energy consumption (in Wh) since the device started operating
3444
# TYPE fritzbox_energy gauge
35-
fritzbox_energy{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} 103023
36-
# HELP fritzbox_power Current power, refreshed approx every 2 minutes
45+
fritzbox_energy{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 339584
46+
# HELP fritzbox_humidity_percent Relative humidity measured as full percentile
47+
# TYPE fritzbox_humidity_percent gauge
48+
fritzbox_humidity_percent{device_id="12345 0000007",device_name="BUTTON_1",device_type="FRITZ!DECT 440"} 54
49+
# HELP fritzbox_power Current power (in W), refreshed approx every 2 minutes
3750
# TYPE fritzbox_power gauge
38-
fritzbox_power{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} 0
51+
fritzbox_power{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 0
3952
# HELP fritzbox_switch_boxlock Switching via FRITZ!Box disabled? 1/0, -1 if not known or error
4053
# TYPE fritzbox_switch_boxlock gauge
41-
fritzbox_switch_boxlock{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} 0
54+
fritzbox_switch_boxlock{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 0
4255
# HELP fritzbox_switch_devicelock Switching via device disabled 1/0, -1 if not known or error
4356
# TYPE fritzbox_switch_devicelock gauge
44-
fritzbox_switch_devicelock{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} 1
57+
fritzbox_switch_devicelock{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 0
4558
# HELP fritzbox_switch_mode Switch mode 1/0 (manual/automatic), -1 if not known or error
4659
# TYPE fritzbox_switch_mode gauge
47-
fritzbox_switch_mode{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} -1
60+
fritzbox_switch_mode{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 0
4861
# HELP fritzbox_switch_state Switch state 1/0 (on/off), -1 if not known or error
4962
# TYPE fritzbox_switch_state gauge
50-
fritzbox_switch_state{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} -1
63+
fritzbox_switch_state{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 0
5164
# HELP fritzbox_temperature Temperature measured at the device sensor in units of 0.1 °C
5265
# TYPE fritzbox_temperature gauge
53-
fritzbox_temperature{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} 19
54-
fritzbox_temperature{device_id="12345 0000000",device_name="HKR 1",device_type="Comet DECT"} 22
66+
fritzbox_temperature{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 20
67+
fritzbox_temperature{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 19
68+
fritzbox_temperature{device_id="12345 0000007",device_name="BUTTON_1",device_type="FRITZ!DECT 440"} 17.5
5569
# HELP fritzbox_temperature_offset Temperature offset (set by the user) in units of 0.1 °C
5670
# TYPE fritzbox_temperature_offset gauge
57-
fritzbox_temperature_offset{device_id="01111 0111111",device_name="Switch 1",device_type="FRITZ!DECT 200"} -1
58-
fritzbox_temperature_offset{device_id="12345 0000000",device_name="HKR 1",device_type="Comet DECT"} -0.5
71+
fritzbox_temperature_offset{device_id="12345 0000001",device_name="SW_1",device_type="FRITZ!DECT 200"} 0
72+
fritzbox_temperature_offset{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 0
73+
fritzbox_temperature_offset{device_id="12345 0000007",device_name="BUTTON_1",device_type="FRITZ!DECT 440"} 0
5974
# HELP fritzbox_thermostat_battery_charge_level Battery charge level in percent
6075
# TYPE fritzbox_thermostat_battery_charge_level gauge
61-
fritzbox_thermostat_battery_charge_level{device_id="44363 2777777",device_name="HKR_1",device_type="Comet DECT"} 70
76+
fritzbox_thermostat_battery_charge_level{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 70
6277
# HELP fritzbox_thermostat_batterylow 0 if the battery is OK, 1 if it is running low on capacity (this seems to be very unreliable)
6378
# TYPE fritzbox_thermostat_batterylow gauge
64-
fritzbox_thermostat_batterylow{device_id="44363 2777777",device_name="HKR_1",device_type="Comet DECT"} 0
79+
fritzbox_thermostat_batterylow{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 0
6580
# HELP fritzbox_thermostat_comfort Comfort temperature configured in units of 0.1 °C
6681
# TYPE fritzbox_thermostat_comfort gauge
67-
fritzbox_thermostat_comfort{device_id="44363 2777777",device_name="HKR_1",device_type="Comet DECT"} 19
82+
fritzbox_thermostat_comfort{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 19
6883
# HELP fritzbox_thermostat_errorcode Thermostat error code (0 = OK), see https://avm.de/fileadmin/user_upload/Global/Service/Schnittstellen/AHA-HTTP-Interface.pdf
6984
# TYPE fritzbox_thermostat_errorcode gauge
70-
fritzbox_thermostat_errorcode{device_id="44363 2777777",device_name="HKR_1",device_type="Comet DECT"} 0
85+
fritzbox_thermostat_errorcode{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 0
7186
# HELP fritzbox_thermostat_goal Desired temperature (user controlled) in units of 0.1 °C
7287
# TYPE fritzbox_thermostat_goal gauge
73-
fritzbox_thermostat_goal{device_id="44363 2777777",device_name="HKR_1",device_type="Comet DECT"} 17
88+
fritzbox_thermostat_goal{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 16
7489
# HELP fritzbox_thermostat_saving Configured energy saving temperature in units of 0.1 °C
7590
# TYPE fritzbox_thermostat_saving gauge
76-
fritzbox_thermostat_saving{device_id="44363 2777777",device_name="HKR_1",device_type="Comet DECT"} 16
91+
fritzbox_thermostat_saving{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 16
7792
# HELP fritzbox_thermostat_window_open 1 if detected an open window (usually turns off heating), 0 if not.
7893
# TYPE fritzbox_thermostat_window_open gauge
79-
fritzbox_thermostat_window_open{device_id="44363 2777777",device_name="HKR_1",device_type="Comet DECT"} 0
94+
fritzbox_thermostat_window_open{device_id="12345 0000002",device_name="HKR_1",device_type="Comet DECT"} 0
8095
```
8196

8297

@@ -89,7 +104,7 @@ docker run -d --name fritzbox_smarthome_exporter -p 9103:9103 \
89104
-v $(pwd)/boxcert.cer:/fritzbox.pem:ro \
90105
-e PASSWORD=SuperSecret \
91106
-e USERNAME=SmarthomeUser \
92-
jaymedh/fritzbox_smarthome_exporter:v0.0.1 -url="https://fritz.box:8443" -cert=/fritzbox.pem
107+
jaymedh/fritzbox_smarthome_exporter -url="https://fritz.box:8443" -cert=/fritzbox.pem
93108
```
94109

95110

0 commit comments

Comments
 (0)