{"id":13604802,"url":"https://github.com/thkl/homebridge-homematic","last_synced_at":"2025-04-05T23:05:23.068Z","repository":{"id":38421186,"uuid":"45619896","full_name":"thkl/homebridge-homematic","owner":"thkl","description":"Homematic plugin for homebridge: https://github.com/nfarina/homebridge","archived":false,"fork":false,"pushed_at":"2022-09-27T06:58:09.000Z","size":1693,"stargazers_count":181,"open_issues_count":114,"forks_count":50,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-03-29T22:08:01.045Z","etag":null,"topics":["automation","homebridge","homekit","homematic","smarthome"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thkl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-05T15:23:50.000Z","updated_at":"2025-03-21T09:16:05.000Z","dependencies_parsed_at":"2022-08-09T04:00:23.695Z","dependency_job_id":null,"html_url":"https://github.com/thkl/homebridge-homematic","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-homematic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-homematic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-homematic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thkl%2Fhomebridge-homematic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thkl","download_url":"https://codeload.github.com/thkl/homebridge-homematic/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411226,"owners_count":20934653,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","homebridge","homekit","homematic","smarthome"],"created_at":"2024-08-01T19:00:51.422Z","updated_at":"2025-04-05T23:05:23.047Z","avatar_url":"https://github.com/thkl.png","language":"JavaScript","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=DZ5CW7XC9LXMN"],"categories":["Interfacing Software"],"sub_categories":[],"readme":"# homebridge-homematic\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"docs/homebridge.png\" height=\"200\"\u003e\n\u003c/p\u003e\n\n[![Donate some coins if you want](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick\u0026hosted_button_id=DZ5CW7XC9LXMN)\n[![Build Status](https://travis-ci.org/thkl/homebridge-homematic.svg?branch=master)](https://travis-ci.org/thkl/homebridge-homematic) [![Greenkeeper badge](https://badges.greenkeeper.io/thkl/homebridge-homematic.svg)](https://greenkeeper.io/)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\nSupports the Homematic System on HomeBridge Platform\n\nIf you just want to add your HomeMatic devices (CCU3/Raspberrymatic/pivCCU) you may also like https://github.com/thkl/hap-homematic\n\n\n\nDevices currently supported:\n\nSwitches , Dimmer , RotaryHandles, WindowContacts, MotionSensor, Blinds, Keymatic\nProgramStarter, SmokeDetector, Thermostats ....\n\n# Installation\n0. Make sure that you use a node version \u003e= 4.5\n1. Install homebridge using: npm install -g homebridge\n2. Install this plugin using: npm install -g homebridge-homematic\n3. Update your configuration file. See the sample below.\n\n# Configuration\n\nConfiguration sample:\n\n ```\n\"platforms\": [\n        {\n            \"platform\": \"HomeMatic\",\n            \"name\": \"HomeMatic CCU\",\n            \"ccu_ip\": \"192.168.0.100\",\n            \"subsection\":\"Homekit\"\n        }   \n    ]\n\n```\n\n# Configuration Changes Version \u003e 214\nBeginning of Version 0.0.214 other that the above configuration settings has been moved to a plugin own config file.\nSo you are able to use the plugin settings in https://github.com/oznu/homebridge-config-ui-x#readme for the initial configuration.\n\nThe file is located at the same path as your config.json and named homematic_config.json\n\nThe plugin will copy your settings once to this file\n\n```\n{\n    \"filter_device\":[],\n    \"filter_channel\":[\"BidCos-RF.KEQXXXXXXX:4\", \"BidCos-RF.LEQXXXXXXX:2\"],\n    \"outlets\":[ \"BidCos-RF.KEQXXXXXXX:4\",\"BidCos-RF.IEQXXXXXXX:1\"],\n    \"doors\":[],\n    \"programs\":[]\n}\n```\n\nPlease use the homematic_config.json to setup new stuff.\n\n\n\n**** BEGINNING OF VERSION 0.0.41 the selection of channels to use with HomeKit via a CCU Subsection is mandatory *****\n\n\nPreselect all the Channels you want to import into Homekit by one Subsection at your CCU.\nCreate a new Subsection (in the Sample named as Homekit) and put all the Channels in you want to import. Finally put the name of the subsection into your config.js\n\nPorts: the plugin will use local Port 9090 to communicate with the ccu rfd daemon. Port 9091 for wired and 9092 for hmip (if they are in use).\nIf these ports are in use by other applications, you can change them by the following key in your homematic_config.json\n\n```\n\"local_port\":8080\n```\n\nIn this case , please make sure that 8081 and 8082 are also available. You got the point ....\n\n\n# Variables\n\nYou may add binaray variables to Homekit by adding them into your homematic_config.json. They will show up as switches.\n\n```\n\"variables\":[\"VarName1\",\"VarName2]\n```\n\n# Programs\n\nIf you want to launch Homematic Programs you can also add them to homematic_config.json.\nThere is a issue with ios10. The build in Home App doesnt handle custom Services so you have to add the ios10 flag in your homematic_config.json\n\n```\n\"programs\":[\"ProgName1\",\"ProgName2\"],\n\"ios10\":true\n```\n\n# Doors and Windows\n\nHomematic Shutter Contacts will be mapped as Contacts into HomeKit by default. If you want to ask Siri about open Windows, you have to add them to a windows config switch:\n\nSo they will be mapped into an motorized Window Device. If you add the channel to the doors configuration switch, this channel will be mapped as automated door.\n\n\n```\n\"doors\":[\"BidCos-RF.KEQXXXXXXX:4\"]\n\"windows\":[\"BidCos-RF.KEQXXXXXXX:4\"]\n```\n\n# HM-LC-RGBW-WM\n\nPlease only add the channel with number 2 to HomeKit.\n\n# HMIP\n\nThe following HMIP Devices should work:\n\n* HMIP-PSM (Switch - Part)\n* HMIP-PS\n* HMIP-SWDO\n* HMIP-SRH\n* HmIP-SMI\n* HMIP-SWSD\n* HMIP-eTRV\n* HMIP-WTH\n* HmIP-WTH-2\n* HmIP-STH\n* HmIP-BWTH\n* HmIP-FSM\n* HmIP-BSM\n* HmIP-BDT\n* HmIP-BROLL\n* HmIP-FROLL\n* HmIP-SWO-B\n* HmIP-SWO-PL\n* HmIP-SWO-PR\n\nPlease setup HMIP by adding the following key to your homematic_config.json\n\n```\n\"enable_hmip\":\"true\"\n```\n\n# Garagedoor\n\nFind further information [here](https://github.com/thkl/homebridge-homematic/wiki/Garagentor).\n\n\n# Troubleshooting\n\nIf the Home app on your iOS device cannot connect to the Homebridge after entering the PIN (and just tells you \"there was a problem\"), this may be caused by too many devices being presented by the bridge. In this case, try to filter some unused devices, e.g. like this if you don't use the \"virtual keys\":\n\n```\n\"filter_device\":[\"BidCoS-Wir\",\"BidCoS-RF\"]\n```\n\n\n# Custom Serviceclasses\n\nYou own a device that is not currently working with the default implementation here? No problem. You can create custom service classes. With a little bit of knowledge from the existing classes in the ChannelServices folder, this should not be a big deal. Copy the HomeMaticHomeKitDummyService and create your own Serviceclass.\n\nAll definitions for the existing classes are located in ChannelServices/channel_config.json. There is a key for each Homematic channeltype and the corresponding name of the service class as value. Be Aware: your personal changes in that file will be overridden by the next update. So you have to set them up in your config.json:\n\n\nAs a sample: the device with the channel WEATHER of the device with type HM-WDS10-TH-O will use the service HomeMaticHomeKitCuxDThermostatService\n\n```\n\"services\": [\n\t{ \"type\": \"HM-WDS10-TH-O:WEATHER\",\n          \"service\": \"HomeMaticHomeKitCuxDThermostatService\"\n\t}]\n\n```\n\nor you could use for example the device HmIP-STH just as a regular Temperature and\nHumidity sensor:\n\n```\n\"services\": [\n  { \"type\": \"HmIP-STH:HEATING_CLIMATECONTROL_TRANSCEIVER\",\n    \"service\": \"HomeMaticHomeKitThermostatWeatherServiceIP\" }\n] \n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthkl%2Fhomebridge-homematic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthkl%2Fhomebridge-homematic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthkl%2Fhomebridge-homematic/lists"}