fritzbox dect

connects DECT ULE devices (fritzdect) to ioBroker

Current Release
2.6.2
Developer
foxthefox
License
MIT

Fritzbox DECT adapter for ioBroker

Setup

IP-address and password of Fritzbox should be defined via admin page, before the first start of the instance. The IP-address must be written with leading 'http://'

The devices are detected automatically during startup of fritzdect instance. If devices are added to the fritzbox during a running adapter instance, then please restart the adapter for object creation.

Several permissions have to be set in the fritzbox in order to interact with the adapter!

If the polling interval is set to 0 in the adapter configuration, automatic cyclic polling is disabled and updates are performed only on demand (via the update command).

A german explanatory doc is available here: install_de

The widget requires that also vis-metro and vis-jqui-mfd are installed

Common Issues / Frequently Asked Questions

  1. Fritzbox returned '00000000' no login possible. possible reasons:

    The fritzbox allows only a limited number of logins in a timeframe. There are no appropriate user rights set in the fritzbox. There is a time elapsing in the fritzbox blocking the logins. A german doc is available here: troubleshooting

  2. using https would result in:

      { error: { [Error: self signed certificate] code: 'DEPTH_ZERO_SELF_SIGNED_CERT' }
    

    to overcome this, the option "rejectUnauthorized: false" is used in the https.request.

Thermostat

Fritzbox AHA API

The API of fritzbox has the following access:

  • sethkrtsoll
    • 8-28°C for automatic control
    • greater 28°C (254=ON)
    • greater 28°C (253=OFF)

These settings are covered by the hkrmode and the 3 buttons. The activation lasts as long there is no other command or programmed sequence.

Additionally there is the access to:

  • windowopenactiv
  • boostactive

These are indications as well as commands (sethkrwindowopen,sethkrboost) and when commanded they act with the provided time limit (max. 24h). For activation of boost/windowopen the following sequence applies:

  • set the activetime to the desired value in minutes
  • activate the activ (from false -> true)
  • the acteendtime changes to the target For deactivation of boost/windowopen the following sequence applies:
  • deactivate the activ (from true -> false)
  • the acteendtime changes to unixtime=0

fritzdect implementation

From the above API possibilities the thermostat has different modes in point of view of iobroker.adapter:

  • auto (temperature control), to be set by hkrmode (0) or button "setmodeauto" -> the tsoll value will be used!
  • night if tsoll = absenk
  • comfort if tsoll = komfort
  • on (full open), to be set by hkrmode (1) or button "setmodeon"
  • off (full close), to be set by hkrmode (2) or button "setmodeoff"
  • boost (full open for limited time), detected by feedback boostactive, can be set by boostactive (false->true)
  • windowopen (full closed for defined time), detected by feedback windowopenactiv, can be set be windowopenactiv (false->true)
  • holiday (temp control), detected by holidayactive
  • summer (temp control), detected by summeractive

ioBroker objects

objects in italic are not part of all fritz.box configurations objects in bold are datapoints from the adapter

The datapoints are created on the basis of the returned values of the Fritz AHA API. All groups or devices start wirth "DECT_".

devices or groups

ObjectValuesettableDescriptionDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
idtext-internal id of deviceDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
nametext-name of deviceDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
productnametext-product nameDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
manufacturertext-product manufacturerDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
fwversiontext-product FW versionDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
modetext-mode, manuell or autoDECT2x0DECT3x0
presentboolean-true/false -> connected/not availableDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
txbusyboolean-true/false -> cmd sending active/not activeDECT2x0DECT3x0DECT400DECT440DECT500BlindsContact
batterylowboolean-battery statusDECT3x0DECT400DECT440Contact
batterynumber-actual capacity in %DECT3x0DECT400DECT440Contact
stateboolean-/xtrue/falseDECT2x0DECT500BlindsContact
powernumber-actual power in WDECT2x0
energynumber-actual energy consumption in WhDECT2x0
voltagenumber-actual voltage in VDECT2x0
lockboolean-UI/API lockDECT2x0DECT3x0
devicelockboolean-Button lockDECT2x0DECT3x0
celsiusnumber-actual temperature in °CDECT2x0DECT3x0DECT440
offsetnumber-offset temperature in °CDECT2x0DECT3x0DECT440
rel_humiditynumber-relative humidity %DECT440
tistnumber-actual temperature in °CDECT3x0
tsollnumberxtarget temperature in °CDECT3x0
komfortnumber-comfort temperature in °CDECT3x0
absenknumber-night temperature in °CDECT3x0
hkrmodearrayx0=AUTO/1=OFF/2=ON state of thermostatDECT3x0
lasttargetnumber-last target temperature in °CDECT3x0
errorcodenumber-errorcodeDECT3x0
operationListnumber-list of possible modesDECT3x0
operationModenumber-actual modeDECT3x0
windowopenendtimetime-time when open window status endsDECT3x0
windowopenactivbooleanxstatus and cmd of window open detectionDECT3x0
windowopenactivtimenumberxtime (minutes) when activation of window openDECT3x0
boostactivebooleanxboost mode active status and cmdDECT3x0
boostactiveendtimetime-time when boost status endsDECT3x0
boostactivtimenumberxtime (minutes) when activation of boostDECT3x0
adaptiveHeatingRunningboolean-adaptive heating statusDECT3x0
adaptiveHeatingActivebooleanxadaptive heating cmdDECT3x0
setmodeautonumberxset AutoDECT3x0
setmodeonnumberxset OnDECT3x0
setmodeoffnumberxset OffDECT3x0
summeractiveboolean-summer program statusDECT3x0
holidayactiveboolean-holiday program statusDECT3x0
tchangenumber-temp with next change in °CDECT3x0
endperiodtime-time when next change is activeDECT3x0
supported_modesnumber-supported colormodesDECT500
fullcolorsupportboolean-fullcolorsupportDECT500
mappedboolean-indication mappedDECT500
unmapped_huenumber-unmapped hue valueDECT500
unmapped_saturationnumber-unmapped saturation valueDECT500
current_modenumber-actual colormodeDECT500
levelnumberxlevel 0-255DECT500Blinds
levelpercentagenumberxlevel 0-100 %DECT500Blinds
huenumberxcolor 0-359DECT500
saturationnumberxsaturation 0-100DECT500
temperaturenumberxcolor temperature (white mode)DECT500
lastpressedtimestamptime-timestampDECT400DECT440Contact
blindsopenbooelanxtarget openBlinds
blindsclosebooleanxtarget closeBlinds
blindsstopbooleanxtarget stopBlinds
lastalertchgtimestamptime-timestampBlinds
enpositionssetboolean-status configurationBlinds
modetext-modusBlinds

stats (part of device)

ObjectValuesettableDescription
countnumber-count of the values in array
gridnumber-time between values in array in s
datatimenumber-reference timestamp for array
statsarray-array of values

Above is available for power and voltage. Additional the energy has monthly and daily array and their belonging descriptive data. Furthermore for energy the array values are summed up for:

  • today
  • last 31 days
  • month to date
  • last 12 month
  • year to date

groups

ObjectValuesettableDescription
masterdeviceidtext-internal id of group
memberstext-member id's of group
masterdeviceidboolean-cmd sending active
synchronizedboolean-devices of group are synchron

templates

ObjectValuesettableDescription
togglebooleanxtoggle switch for template activation
lasttemplatetext-last confirmed template

routines

ObjectValuesettableDescription
activebooleanxtoggle switch for routine activation

Manual Update

It is possible to trigger a manual update, for example between polling intervals or when polling is disabled. To do this, send a message with the text "update" and no parameters to the adapter instance. The optional callback will be executed once the update is complete.

Below is an example demonstrating how to trigger the manual update:

sendTo('fritzdect.0', 'update', null, e => {
    if (e['result']) {
        // update successful
    } else {
        console.log(e['error']);
    }
});

API limitations

  • Boost and WindowOpen can only be set for the next 24h. time=0 is cancelling the command
  • updates to the thermostat are within a 15min range, depending on the previous communication of thermostat with fritzbox the next cycle is sooner or later, but definitely not imediately after an ioBroker intervention
  • if a windowopenactiv is set on a thermostat, which is part of a group, then the whole group and its thermostats is set to windowopenactiv (function inside the FB)
  • only a few color temperatures are accepted (mapped already be the API to valid ones)
  • only the predefined colors are valid combinations (getcolordefaults)

Write only on changes to the objects

This is a new feature to write only the changes to the objects. It reduces the logging and might be useful. If it is activated, a different feedback must be present to the actual state. Introducing a hysteresis makes not really practicable:

  • if temperatures have a change, it is a change and the 0.5° step does not need a threshold
  • values which are increasing over time would need an absolut threshold and not in %
  • values scaled to 100 are transmitted in steps of 1, so a threshold of 1% is capturing the same steps otherwise it is more complex and individually to be parametrized.

3rd party devices (HAN-FUN, ZigBee)

These devices are split into a device and an unit (the function itself). The device has usually no interactions and therefore is not created in the adapter. The information portion and datapoints (i.e. battery status) of the device is merged into the unit. The id shown in the adapter belongs to the unit (which is not shown in the FB-App).

Known Adapter Limitations:

  • Not all FW-versions of fritz.box support all objects.
  • use exclude possibility in adapter config, to disable communication related to newer functions
  • some datapoints are unavailable in newer FB-FW-versions (i.e. buttons of DECT440)

TODO:

  • map of data input from user to valid predefined colors (nearest match)
  • blind alert state -> decode bit array

Changelog

WORK IN PROGRESS

  • (copilot) Adapter requires node.js >= 22 now

2.6.4 (WIP)

  • new IKEA lamp commands issue #625
  • object corrections
  • thermostat temp tist max 40°C

2.6.3 (npm)

  • update to comply with repo checker

License

The MIT License (MIT)

Copyright (c) 2018-2026 foxthefox foxthefox@wysiwis.net