homebridge-fritz-platform

Creating and maintaining Homebridge plugins consume a lot of time and effort, if you would like to share your appreciation, feel free to "Star" or donate. Click here to review more of my plugins.

Click here to review more of my plugins.

Info

This plugin allows almost full control of AVM hardware like:

• Fritz!Box
  • Router status and switch functionality,
  • WLAN 2.4Ghz,
  • WLAN 5Ghz,
  • WLAN Guest,
  • WPS,
  • DECT,
  • Answering Machine,
  • Deflection,
  • Device LED,
  • Device Lock,
  • Ring Lock,
  • Phonebook,
  • Alarm,
  • Wakeup,
  • DNS Server
  • Broadband
  • Reconnect
  • Child Lock
  • Fallback Internet
• Fritz!Repeater
  • Repeater status and switch functionality,
  • WLAN 2.4Ghz,
  • WLAN 5Ghz,
  • WLAN Guest,
  • WPS,
  • Device LED,
  • Device Lock
• Fritz!Fon
  • Callmonitor (with adjustable filter for incoming/outgoing numbers),
  • FakeGato support
• Fritz!DECT Buttons, Telekom Wandtaster
  • Support for buttons with 1/4 channels
  • Temperature sensor with FakeGato,
  • Humidity sensor with FakeGato,
  • FakeGato support
• Fritz!DECT Outlets, Fritz!Powerline Outlets
  • Switch/Outlet status and switch functionality,
  • Power meter,
  • Temperature sensor with FakeGato,
  • Telegram notification when device is in use/not in use
  • FakeGato support
• Fritz!DECT Lights
  • Light status and switch functionality,
  • Brightness adjustment,
  • Color adjustment,
  • Apple adaptive lighting
• Fritz!DECT Thermostats, Comet!DECT Thermostats
  • Thermostat current state, target state, current temperature and target temperature state and switch functionality,
  • Temperature sensor,
  • Humidity sensor with FakeGato,
  • Window sensor (for window open functionality)
  • Open Window detection (to trigger manually open window)
  • FakeGato support
• Rollotron DECT 1213/Blind/Shutter
  • Position adjustment/status
• HAN-FUN sensors (e.g. Deutsche Telekom)
  • Contact state,
  • FakeGato support
• Presence
  • Detect occupancy through wifi,
  • Detect occupancy through guest wifi,
  • Fakegato support
• Watch Network
  • Control devices if connected or disconnected from network
• Telegram
  • Receive custom messages for occupancy detection (presence), device detection (watch network), incoming/outgoing calls (callmonitor), alarm, router state and outlet usage

Any system capable of running Homebridge can be used to run homebridge-fritz-platform. The only need is network access to the device or program in question.

Changelog

See the changelog for changes between versions of this package.

NOTE: Updating from < v5.x to >= v5.x will crash your homebridge, please REMOVE the old version first and check also the new example-config.json !

Documentation

• Supported HomeKit Apps
• Tested Devices
• Installation instruction
• First Start
• Configuring Callmonitor
• Examples
  • Example config.json
  • Multiple instances (for extended reboot)
  • Telegram Notification instructions
• Debugging

Contributing

You can contribute to this homebridge plugin in following ways:

• Report issues and help verify fixes as they are checked in.
• Review the source code changes.
• Contribute bug fixes.
• Contribute changes to extend the capabilities
• Pull requests are accepted.

This Plugin uses modules from others, see CONTRIBUTING for credits.

Disclaimer

All product and company names are trademarks™ or registered® trademarks of their respective holders. Use of them does not imply any affiliation with or endorsement by them.

Changelog

v6.0.19 - 2021-10-06

Bugfixes

• Minor Bugfixes

v6.0.18 - 2021-10-06

Bugfixes

• Minor Bugfixes

v6.0.17 - 2021-10-06

Other Changes

• Updated dependencies

Bugfixes

• Fixed an issue where smarthome thermostat groups did not display the average current temperature
• Fixed an issue where starting wps failed and showed wrong state
• Fixed an issue where setting thermostat to max temperature (via FritzBox) displayed wrong state/temperature in HomeKit
• Fixed an issue where scenes/automations do not work properly with Smarthome thermostats
• Minor Bugfixes

v6.0.16 - 2021-09-21

Notable Changes

• Presence
  • Guest Wifi Presence: Occupancy/Motion sensor which will be triggered if someone is connected to the guest wifi (master device)

Bugfixes

• Fixed an issue where number lookup didnt work properly (callmonitor)
• Fixed an issue where turning on the deflection affected only the first deflection in the list
• Minor Bugfixes

v6.0.15 - 2021-09-19

Other Changes

• Updated dependencies

Bugfixes

• Fixed an issue where smarthome thermostat groups did not display the average current temperature
• Fixed an issue where smarthome buttons did not work properly
• Fixed an issue where router led state did not work properly
• Minor bug fixes

v6.0.14 - 2021-07-08

Bugfixes

• Fixed an issue where thermostats did not display the temperature value of the external temperature when externTemperatureSensor is enabled

v6.0.13 - 2021-07-08

Bugfixes

• Fixed an issue where changing color of smarthome lightbulbs showed wrong color/saturation

v6.0.12 - 2021-07-08

Notable Changes

• Smarthome
  • Changed "Humidity Sensor" from built-in sensor to a separate humidity sensor accessory
  • Added new externTemperatureSensor option for thermostat accessories to use the temperature value from the external temperature sensor setted up in the FritzBox GUI

Other Changes

• Reduced minimum polling timer to 1

Bugfixes

• Fixed an issue where enabling temperature or humidity doesnt work for several smarthome accessories
• Fixed an issue where receiving an error during sending a telegram message caused homebridge to crash
• Fixed an issue where thermostat open window switch caused a warning on startup
• Minor bug fixes

v6.0.11 - 2021-07-04

Other Changes

• Updated dependencies

Bugfixes

• Fixed an issue where buttons with 4 channels didnt work properly

v6.0.10 - 2021-06-28

Bugfixes

• Fixed an issue where authentication with a complex password didnt work

v6.0.9 - 2021-06-28

Bugfixes

• Fixed an issue where changing lightbulb color didnt work

v6.0.8 - 2021-06-27

Bugfixes

• Fixed an issue where restarting a router failed
• Minor bug fixes

v6.0.7 - 2021-06-27

Bugfixes

• Fixed an issue where presence user throw an erorr if it could not be found manually or in the hosts list
• Minor bug fixes

v6.0.6 - 2021-06-27

Other Changes

• Updated dependencies

Bugfixes

• Fixed an issue where restarting a router failed
• Minor bug fixes

v6.0.5 - 2021-06-23

Other Changes

• Improved logging

Bugfixes

• Fixed an issue where callmonitor (outgoing) not triggered correctly

v6.0.4 - 2021-06-22

Bugfixes

• Minor bug fixes

v6.0.3 - 2021-06-22

Notable Changes

• Log:
  • Added multiple logging functions to config to allow adjusting the logging output.
• Smarthome:
  • Buttons: Added support for Telekom Wandtaster
• Config:
  • Buttons: Added longPress option to smarthome buttons

Other Changes

• Updated dependencies

Bugfixes

• Fixed an issue where presence devices with an ip address in the config could not be exposed to HomeKit.
• Minor bug fixes

v6.0.2 - 2021-06-22

Other Changes

• Better error handling in the backend

Bugfixes

• Fixed an issue where extra characteristics was not polling
• Fixed an issue with Telegram where also the subtypes of an accessory was shown in the message
• Minor bug fixes

v6.0.1 - 2021-06-21

Bugfixes

• Minor bug fixes
• Cleaned up config.schema.json

v6.0.0 - 2021-06-21

This update is by far the biggest update for homebridge-fritz-platform. To make adding new devices also easier for developers, the complete plugin has been rewritten and made modular. This should give all developers the possibility to read the code more easily and add new devices via PR themselves.

Breaking Changes

• Homebridge
  • Dropped support for homebridge below v1.3.0
• Devices:
  • Added active key to devices to enable/disable the device without removing it from config. Warning: Default value for active is false, this means, that if you DON'T adjust your config.json and add "active": true to the device, the device will be removed from HomeKit!
• Smarthome:
  • Added active key to smarthome to enable/disable the device without removing it from config. Warning: Default value for active is false, this means, that if you DON'T adjust your config.json and add "active": true to the device, the device will be removed from HomeKit!
• WOL:
  • Added active key to wol to enable/disable the device without removing it from config. Warning: Default value for active is false, this means, that if you DON'T adjust your config.json and add "active": true to the device, the device will be removed from HomeKit!
• Network Monitoring:
  • Added active key to network to enable/disable the device without removing it from config. Warning: Default value for active is false, this means, that if you DON'T adjust your config.json and add "active": true to the device, the plugin will not notify you if the device is online/offline!

Notable Changes

• Child Lock:
  • Added new childLock array into config to expose child lock switches for given device. Child Lock switches grants/denies acces to the internet for the given ip addresses.
• Devices:
  • Added a new option wifiUnits to devices to manually set the available wifi units (support for multiple units like 1x 2.4Ghz and 2x 5Ghz)
  • Added a new option reconnect to device options to expose a Reconnect characteristic/switch which interrupt the internet access and reconnect (for changing external ip)
• Smarthome:
  • Blinds: Added blind as a new accessory (accType) type
  • Buttons: Added button as a new accessory (accType) type with 1/4 button support with oen polling timer (timerSmarthomeButtons) configurable under options.polling.timerSmarthomeButtons
  • Thermostat:
    • Added new openWindow option to expose an switch to manually trigger open/close window
  • Outlet:
    • Added new startValue option which is used for notification via telegram when device started (current power consumption above this value) or ended (current power consumption below this value)
• Extras:
  • Added new dnsServer option to extras config to expose a switch which toggles the dns server from fritzbox to "internet provider" or "own dns server"
  • Added new fallbackInternet option to extras config to expose a switch which toggles the fallback internet option from fritzbox
• Presence:
  • Moved onDelay and offDelay from options.presence to presence user to allow separate values for each user
• Callmonitor:
  • Added incomingFrom array into callmonitor options to allow trigger callmonitor only for speicifc numbers
• Telegram:
  • Added outlet.started and outlet.finished as a new option to notify via Telegram if device is started/finished
• Options:
  • Removed onDelay and offDelay from options.presence
  • Added timerSmarthomeButtons to options.polling
• Polling:
  • Refactored exclude list. Now, only following type of accessories/characteristics can be excluded from polling: dsl (accessory name), cable (accessory name), repeater (accessory name), wifi_2ghz, wifi_5ghz, wifi_guest, wps, led, lock, aw, dect, deflection, ringlock
  • Minimum/Default polling timer (seconds) increased to 15 seconds

Other Changes

• The code has been refactored (again)
• Adjusted config.schema.json to reflect the changes mentioned above
• Updated dependencies

Bugfixes

• Minor bug fixes

v5.1.2 - 2021-05-30

• Fix CreateUrlSID for DECT

v5.1.1 - 2021-05-30

• Bump dependencies

v5.1.0 - 2021-05-20

• Refactored backend module @seydx/fritzbox
• Some minor improvements and bugfixes
• Bump dependencies

v5.0.33 - 2021-05-19

• Fixed an issue where changing temperature from thermostat was not possible with Siri
• Bump dependencies
• Minor bugfixes and improvements

v5.0.32 - 2021-03-22

• Bugfix

v5.0.31 - 2021-03-16

• Added "cooling" state to HeaterCooler

v5.0.30 - 2021-03-16

• Changed Smarthome Thermostat Service to HeaterCooler Service

WARNING

This change will break your automations with your smarthome thermostats because they will be removed from HomeKit and re added again as a new type of thermostats!

v5.0.26 - 2021-03-14

• Fixed characteristic warnings from eve characteristics (fakegato)
• Bump dependencies

v5.0.25 - 2021-02-28

• Fix #157
• Fix #139

v5.0.24 - 2021-02-28

• Fixed broadband

*INFO: * If you have "Broadband" active you have to deactivate it after the update, restart HB and reactivate "Broadband" !

v5.0.23 - 2021-02-28

• Refactored broadband again

v5.0.22 - 2021-02-27

• Refactored broadband

v5.0.21 - 2021-02-24

• Bugfixes

v5.0.20 - 2020-12-05

• Fix smarthome humidity

v5.0.19 - 2020-12-05

• Fixed answering machine
• Improved debug for smarthome devices/groups

v5.0.18 - 2020-12-04

• Updated config.schema.json to support humidity sensor

v5.0.17 - 2020-12-04

• Added humidity sensor for supported smarthome devices (currently available only with Fritz!OS 7.24)

v5.0.16 - 2020-11-27

• Bugfixes

v5.0.15 - 2020-11-27

• Added new option to expose grouped smarthome devices.
• Adaptive Lighting
• Bugfixes

Grouped Smarthome Devices

Grouped Smarthome Devices can be exposed as Lightbulbs, Switches/Outlets or a combination of both. If the group has a lightbulb AND a switch, the accessory will get both services and additionally (if enabled and supported by the device) a temperature sensor. The grouped switches/outlets and switch-lightbulbs comes also with FakeGato support and "ReadOnly" possibility. Lightbulbs and Switch-Lightbulbs also supports adaptive lighting.

v5.0.14 - 2020-11-22

• Fixed ColorUtils for Smarthome Lightbulbs
• Removed waitFor* timeout for LightBulbs and Thermostats

v5.0.13 - 2020-11-15

• Added new option: "cityPrefix" for callmonitor for better call detection
• Added new option: "active" for user (presence) to easily switch between enabled/disabled
• Added new option: "blockTelegram" for user (presence) to block sending telegram notification
• Phonebook improvements
• Added custom FakeGato timer for all FakeGato enabled accessories to fix gaps is histories
• Bugfixes

v5.0.12 - 2020-11-15

• Fixed a bug with smarthome-window battery service
• Added function to remove battery service
• Bugfixes

v5.0.11 - 2020-11-15

• Added more information to callmonitor telegram (now % will be replaced with your home nr)
• Replaced Telegraf with FormData
• Bugfixes

v5.0.10 - 2020-11-15

• Added countryPrefix option to Callmonitor tu spport FritzBox devices without VOIP function
• Disabled AdaptiveLighting (not supported with official homebridge release, coming back with homebridge v1.3)
• Changed callmonitor incomingTo/outgoingFrom logic
• Bugfixes
• Bump FakeGato

v5.0.9 - 2020-11-14

• Support for apple daptive lighting (coming with hb 1.3) for smarthome lightbulbs
• Bugfixes

v5.0.8 - 2020-11-12

• Added support for color lightbulbs (eg DECT500)
• Bugfixes

v5.0.7 - 2020-11-11

• Added new smarthome types (window/temperature)
• Fixed smarthom lightbulb
• readOnly for smarthome switch
• Added broadband again to meshMaster as characteristic (API)
• Bump fritzbox dep to fix username/passwords with special chars

v5.0.6 - 2020-11-10

• Fixed callmonitor caller/called nr

v5.0.5 - 2020-11-10

• Fixed callmonitor outgoing call

v5.0.4 - 2020-11-10

• Fixed phonebook fetching numbers
• Updated fritzbox dep to allow special chars
• Fixed config.schema.json copy&paste

v5.0.3 - 2020-11-10

• Fixed phoneBook readJson function

v5.0.2 - 2020-11-10

• Fixed wol switch

v5.0.1 - 2020-11-10

• Support for homebridge v1.3.0

v5.0.0 - 2020-11-10

• Completely rewritten
• New: Homebridge (latest/beta) Support
• New: Config UI X Integration
• New: Polling with additional functions (exclude accessories)
• New: Possibility to display all 'Extras' like Wifi, Alarm, Led etc etc as Characteristic or as a separate switch in Apple Home
• New: Network Watch
• New: Configurable Callmonitor names
• New: Group Callmonitor sensors
• New: DECT station
• New: Ability to hide devices (router)
• New: Additional ping for presence
• New: Ability to change accessory typ for presence and anyone sensor, with FakeGato support
• New: Smarthome devices with FakeGato Support
• New: Smarthome Outlet Accessory with Fakegato for powermeter
• New: Smarthome Window Accessory with Fakegato for devices with built in windowOpen function
• New: Support for SmartHome Lights (only on/off and brightness)
• Removed: Broadband for compatibility reasons

BREAKING CHANGES

The new version is not compatible with version < 5! If you use version < 5 of this plugin, please remove it from Homekit/Homebridge before updating!

v4.1.0 - 2019-06-16

• "Ping" feature was added as an extra check (if enabled in config.json)
• Phonebook Bugfix

v4.0.9 - 2019-05-25

• Refactored Broadband measurement

v4.0.8 - 2019-05-25

• Bugfixes (generating SID)

v4.0.7 - 2019-05-24

• Bugfixes (callmonitor)
• Better debug (smarthome)

v4.0.6 - 2019-05-22

• Refactored phoneBook
• Added "Blacklists" to Phonebook

v4.0.4 - 2019-05-20

• Added better state detection for repeater

v4.0.3 - 2019-05-20

• Bugfixes (SID)

v4.0.2 - 2019-05-20

• Added option to disable auto search

v4.0.1 - 2019-05-20

• Bugfixes
• Cleanup code

v4.0.0 - 2019-05-19

• Refactored code
• Refactored API
• Support async/await
• Add automatically all supported devices in network to config
• Added own debug params (FritzPlatformApi,FritzPlatformTR064,FritzPlatformLUA)
• Auto config generator/validator at start
• Bugfixes

v3.2.4 - 2019-04-26

• Bugfix

v3.2.3 - 2019-04-24

• Bugfix (extReboot Telegram)

v3.2.2 - 2019-04-24

• [NEW] Markdown Support for telegram notifications

v3.2.1 - 2019-03-22

• Bugfixes
• Code cleanup

v3.2 - 2019-03-21

• [NEW] Presence: new function 'onDelay'
• [NEW] Smarthome: New accessory (contact sensor) for window open active function (thermo)
• Code cleanup

v3.1.5 - 2019-03-19

• Bump dependencies
• Code cleanup

v3.1.4 - 2019-03-18

• [NEW] It is now possible to add multiple numbers to "incomingTo" and "outgoingFrom" (Callmonitor)
• Code cleanup
• Bugfixes

v3.1.3 - 2019-03-18

• Rewrite smarthome (fixed a bug with 404 not found error)

v3.1.2 - 2019-03-17

• Bugfixes

v3.1.1 - 2019-03-17

• Bugfixes (Smarthome, presence)

v3.1.0 - 2019-03-17

• Smarthome: Changed "switch" accessory to "outlet" accessory
• Smarthome: Better "present" detection for smarthome devices
• PhoneBook: Auto refresh phonebook (polling: 1h)

Info: If you have Smarthome devices of type "switch" please REMOVE it first from HomeKit and config.json, restart homebridge and be sure that the accessory is removed from HomeKit! Re-add it again to config.json with the same parameter as before! This time it will expose as "outlet" to HomeKit, otherwise it can break your setup!

vv3.0.7 - 2019-03-16

• Fixed a bug with smarthome

v3.0.6 - 2019-03-16

• Fixed a bug with callmonitor (outgoing calls)
• Added "test" file

v3.0.5 - 2019-03-16

• Fixed a bug with empty config.json
• Fixed several bugs with smarthome
• Added 'present' function to smarthome

v3.0.4 - 2019-03-03

• Fixed a bug with fetching SIDs for multiple devices

v3.0.3 - 2019-03-03

• Added new function to callmonitor: Specify numbers for "incoming to" and "outgoing from" calls (usefull if using multiple numbers at home and want to trigger only for specified number in config

v3.0.2 - 2019-03-02

• Added new function to devices: "Read Only"

v3.0.1 - 2019-03-02

• Fixed FakeGato for callmonitor and smarthome devices

v3.0.0 - 2019-03-02

Breaking changes, remove v2.x first before continue! Check also the new example-config.json !

• [NEW] Callmonitor with extended FakeGato support
• [NEW] Callmonitor PhoneBook with auto prefix functionality
• [NEW] Callmonitor PhoneBook ultra fast storing
• [NEW] Support of BETA FritzBox firmware
• [NEW] Support of MESH functionality to decrease request amounts
• [NEW] Ring Lock
• [NEW] Fallback if no connection
• [NEW] Better debug logger (-D)
• [NEW] SmartHome Devices (plugs, contact sensors and thermostats)
• [NEW] SmartHome Switch accessory with external temp sensor accessory
• [NEW] FakeGato for smarthome devices
• [FIX] Better presence detection
• [FIX] Bugfixes and Speed improvements
• [BETTER] Rewritten dynamic platform
• [BETTER] Resource efficient
• [REMOVE] Presence as motion sensor
• [REMOVE] FakeGato for presence sensor

v2.8.0 - 2018-02-11

• Fix TR064 Api

v2.7.1 - 2018-06-20

• Bugfixes
• Note: "smarthome" were changed in config.json! Please check before update. (example-config.json)
• Note: 'thermo' & 'contact' currently not supported (smarthome)

v2.7.0 - 2018-06-19

• Added Smarthome devices
• Code cleanup
• Better error handling
• Bugfixes
• Added own reboot functionality to repeater. example-config.json
• Removed repeater reboot from main device

v2.6.4 - 2018-06-18

• Bugfixes
• Code cleanup
• Better error handling

v2.6.2 - 2018-06-18

• Code clean up
• Bugfixes
• Added "refresh wifi canal"

v2.6.0 - 2018-06-17

• Bugfixes
• Remote Login possibility see docs
• Updated dependencies
• Better interaction with the TR064 module

v2.5.1 - 2018-06-15

• Bugfixes
• Code cleanup

v2.5.0 - 2018-06-15

• Bugfixes
• Integrated tr064 api
• Speed up
• Code cleanup

v2.4.4 - 2018-06-14

• Fixed callmonitor telegram notification
• Fixed Repeater state

v2.4.3 - 2018-06-13

• Bugfixes
• Clean up code

v2.4.2 - 2018-06-13

• Bugfixes
• Added called nr to callmonitor and telegram (% in config.messages.incoming as dynamic input)
• Added more flags to LogUtil
• Increased min timeout limit from 5s to 10s
• Better error handling
• Reboot function to repeater main switch > if switch off > reboot

v2.4.1 - 2018-06-12

• Updated dependencies
• Fixed a bug in TR064 module that caused "Auth. Failed" by multiple requests

v2.4.0 - 2018-06-11

• Fixed telegram notification for callmonitor

v2.3.8 - 2018-06-11

• Changed presence polling
• Added possibility to remove/add "Anyone" sensor from config.json (see example-config.json)

v2.3.7 - 2018-06-11

• Better presence detection
• Changed telegram notification for presence (see example-config.json)
• Changed telegram function (possibility to choose which message should pushed as notification, if any message field = "" or not exist, you will not receive any notification for only this function without affecting other functions)
• Polling limit reduced from 10s to 5s
• Bugfixes
• New Debug tool

v2.3.6 - 2018-06-08

• Fixed Auth. failure (presence)
• Fixed Telegram push notification (presence)

v2.3.4 - 2018-06-08

• Fixed Auth. failure (presence)

v2.3.3 - 2018-06-08

• Changed presence structure (see example-config.json)
• An error has been fixed that caused the presence sensors not to switch correctly (if no presence detected)
• Improved presence adresse detection
• Possiblitiy to add ip adress to presence

v2.3.2 - 2018-06-08

• Added "type" option to presence sensors (motion/occupancy)
• Fixed a bug with presence delay
• Update dependencies
• Clean up code

v2.3.1 - 2018-06-07

• Added type to config.json to support cable router ("type":"cable" , Default: "type":"dsl")

v2.3.0 - 2018-06-07

• Added "delay" option to presence
• Bugfixes (callmonitor)
• Fixed a bug with initializing config.json

v2.2.7 - 2018-06-07

• Added ip information for Reboot and Reconnect
• Clean up code

v2.2.5 - 2018-06-06

• Created initial basic accessory and initial work