homebridge/homebridge-syno-spk

Homebridge Package for Synology DSM 7.

Homebridge

Homebridge is a lightweight Node.js server you can run on your home network that emulates the iOS HomeKit API. It supports Plugins, which are community-contributed modules that provide a basic bridge from HomeKit to various 3rd-party APIs provided by manufacturers of "smart home" devices.

Since Siri supports devices added through HomeKit, this means that with Homebridge you can ask Siri to control devices that don't have any support for HomeKit at all. For instance, using just some of the available plugins, you can say:

• Siri, unlock the back door. [pictured to the right]
• Siri, open the garage door.
• Siri, turn on the coffee maker.
• Siri, turn on the living room lights.
• Siri, good morning!

You can explore all available plugins at the NPM website by searching for the keyword homebridge-plugin.

Community

The official Homebridge Discord server and Reddit community are where users can discuss Homebridge and ask for help.

HomeKit communities can also be found on both Discord and Reddit.

Installation

Raspberry Pi

Official Homebridge Raspberry Pi Image
Install Homebridge on Raspbian

---

Linux

Debian or Ubuntu Linux | Red Hat, CentOS or Fedora Linux | Arch / Manjaro Linux|Install Homebridge on Arch Linux

---

macOS

Install Homebridge on macOS

---

Windows 10 / 11

Install Homebridge on Windows 10 / 11 Using Hyper V

---

Docker

Install Homebridge on Docker
Synology | Unraid | QNAP | TrueNAS Scale

---

Synology DSM

Install Homebridge on Synology DSM 7

Other Platforms

Other Platforms

Adding Homebridge to iOS

1. Open the Home app on your device.
2. Tap the Home tab, then tap .
3. Tap Add Accessory, then scan the QR code shown in the Homebridge UI or your Homebridge logs.

If the bridge does not have any accessories yet, you may receive a message saying Additional Set-up Required, this is ok, as you add plugins they will show up in the Home app without the need to pair again (except for Cameras and TVs).

Cameras and most TV devices are exposed as separate accessories and each needs to be paired separately. See this wiki article for instructions.

Interacting with your Devices

Once your device has been added to HomeKit, you should be able to tell Siri to control your devices. However, realize that Siri is a cloud service, and iOS may need some time to synchronize your device information with iCloud.

One final thing to remember is that Siri will almost always prefer its default phrase handling over HomeKit devices. For instance, if you name your Sonos device "Radio" and try saying "Siri, turn on the Radio" then Siri will probably start playing an iTunes Radio station on your phone. Even if you name it "Sonos" and say "Siri, turn on the Sonos", Siri will probably just launch the Sonos app instead. This is why, for instance, the suggested name for the Sonos accessory is "Speakers".

Plugin Development

The https://developers.homebridge.io website contains the Homebridge API reference, available service and characteristic types, and plugin examples.

The Homebridge Plugin Template project provides a base you can use to create your own platform plugin.

There are many existing plugins you can study; you might start with the Homebridge Example Plugins or a plugin that already implements the device type you need.

When writing your plugin, you'll want Homebridge to load it from your development directory instead of publishing it to npm each time. Run this command inside your plugin project folder so your global installation of Homebridge can discover it:

npm link

You can undo this using the npm unlink command.

Then start Homebridge in debug mode:

homebridge -D

This will start up Homebridge and load your in-development plugin. Note that you can also direct Homebridge to load your configuration from somewhere besides the default ~/.homebridge, for example:

homebridge -D -U ~/.homebridge-dev

This is very useful when you are already using your development machine to host a "real" Homebridge instance (with all your accessories) that you don't want to disturb.

Common Issues

Home App Says Accessory Already Added

To fix this, Reset Homebridge.

My iOS App Can't Find Homebridge

Try the following:

1. Swap between the Bonjour HAP and Ciao mDNS Advertiser options. See the wiki for more details.
2. iOS DNS cache has gone stale or gotten misconfigured. To fix this, turn airplane mode on and back off to flush the DNS cache.

Limitations

• One bridge can only expose 150 accessories due to a HomeKit limit. You can however run your plugins as a Child Bridge or run Multiple Homebridge Instances to get around this limitation.
• Once an accessory has been added to the Home app, changing its name via Homebridge won't be automatically reflected in iOS. You must change it via the Home app as well.

Why Homebridge?

Technically, the device manufacturers should be the ones implementing the HomeKit API. And I'm sure they will - eventually. When they do, this project will be obsolete, and I hope that happens soon. In the meantime, Homebridge is a fun way to get a taste of the future, for those who just can't bear to wait until "real" HomeKit devices are on the market.

Credit

Homebridge was originally created by Nick Farina.

The original HomeKit API work was done by Khaos Tian in his HAP-NodeJS project.

homebridge-syno-spk's Issues

[Feature request] Allow configuration of the shortcut

I have migrated from manual docker management and everything works fine for me, so thanks for the work on this app!

I have minor feature request. I would like the DSM shortcut pointing to the homebridge UI to be useful but I don't have its port exposed as I think this is good security practice to not expose its port or map it do different than the default one. I would like it to be configurable so I could provide my local IP (so it will work locally) and/or another port.

Thanks!

Couldn't connect Home app and loading Web UI

I couldn't loading the Web UI, it's works at first time installed. Some reason I change my network setting. And then, I reinstall the homebridge-syno-spk. HomeBridge works fine but I couldn't connected to Home APP and enter Web UI. I think the problem is HomeBridge couldn't connected but I have no idea why the issue happen. Could you help~~~~~please.

My Config:
{
"bridge": {
"name": "Homebridge",
"username": "CC:22:3D:E3:CE:30",
"port": 51826,
"pin": "031-45-154"
},

"description": "This is an example configuration file. You can use this as a template for creating your own configuration file containing devices you actually own.",

"accessories": [
],

"platforms": [
]

}

Attached log. 192.168.1.3 is my NAS.

Homebridge icon does not redirect rigth

I have already installed the package, and everything is working just right, there is only one thing that is a little strange:
The icon placed in my Synology NAS (DS916+ with DSM 6.2.1-23824 Update 6 [latest at this time]) is redirecting me to myhostname:8581, but the Homebridge-UI-X is running under port 8080.
If I try to reach port 8080, it is reachable and it is working as expected (even with certs and https), but the icon is linking to port 8581, where the service itself is running.

Do you know why this is happening and how to solve it?

Homebridge UI

Brilliant work! As I encountered the same issues with ip issues after upgrade, this is perfect! Unfortunately the Homebridge UI doesnt let me sign in. It always reports "Invalid Username and Password". Maybe it is an issue with my previous installation? Thanks in advance! C.

Publish Homebridge to SynCommunity repository

You could compile Homebridge for all Synology NAS models by using spksrc (supports all architectures, not only x86), and bring automatic updates to the packages by publishing to theSynoCommunity repository.

Config UI does not work out of the box

I just tried to install your SPK. Thank you for making it.

However, config UI X plugin doesn't seem to be installed by default. When you click on the Homebridge icon in the Synology menu it doesn't work.

I fixed it by adding npm install homebridge-config-ui-x to startup.sh and added the right platform to config.json manually. (I just followed the plugin's instructions)

Hope this'll help.

Cannot Install Homebridge on a DS212J with DSM 6.2.2-24922 Update 4

Hello,

when I want to install hombridge-doke.spk I get the following Issues:

The package is not compatible with your Plattform or is not compatible with your DMS Version.
Cann you help me?

Does not work @DSM7

spk does not work on current dsm 7 beta. didnt get homebridge working on that version of dsm

Can't connect to iOS Home

I've tried the tips listed here: #5

At this point I've changed nearly every setting away from default and still I can't get it to connect. For a little while I was actually able to discover it in the Home app but connecting would spin and spin before failing. Then I turned off the container and it was still showing in Home via bonjour, which seemed wrong... So I restarted my phone and it was gone-- but then spun the container back up and it never re-appeared... Now, still connecting with QR and pin is not working. Any thoughts?

Host name conflict?

So occasionally, I have an issue where I cannot connect to Homebridge, but everything seems to work meaning I can see cameras and other devices.

I went into the synology docker logs today and I saw the above. Have you seen this before?

CANNOT INSTALL ON DSM7

packet installation failure must run with lesser privilege

The format of HomebridgeDocker-86x....spk file is invalid

When trying to add the image as file in docker (synology), I receive the mentioned error message.

This is after I deleted another version of the .spk which I was able to select. Can you guys help me adding the image?

I tried uninstalling docker and re-installing it but that did not bring any help.

Thanks

Not installable

Hi, unfortunately I cannot install Homebridge on my Synology :/ Is it too old?
More information in the pictures

How to install plugin fork?

When searching for plugins to install, for example the highly popular Homebridge-isy-js the main one shows, however that plugin for instance was abandoned years ago, but a fork has taken over as the main one. Homebridge-isy-js even links and recommends the fork in the release notes. But on this plugins search it only shows the original (the discontinued one) and don't see how to choose the fork that replaces it?

Cant install on DS420+ with DSM6.2.3

Hi I cant install homebridge-syno-spk on my DS420+
My DSM version is 6.2.3

"Multiple instance of Homebridge Found Installed"

I deleted a previous version of Homebridge that I had running on my Nas and installed this one, and I'm getting this error in the log occasionally.

2019-07-23 03:59:48,stdout,"�[0;37m[7/22/2019, 11:59:48 PM] �[0m�[0;36m[Config]�[0m �[0;33mMultiple Instances Of Homebridge Found Installed�[0m
"
2019-07-23 03:59:48,stdout,"�[0;37m[7/22/2019, 11:59:48 PM] �[0m�[0;36m[Config]�[0m �[0;33m/homebridge/node_modules/homebridge�[0m
"
2019-07-23 03:59:48,stdout,"�[0;37m[7/22/2019, 11:59:48 PM] �[0m�[0;36m[Config]�[0m �[0;33m/usr/local/lib/node_modules/homebridge�[0m

Everything seems to be working fine, but any idea what I need to cleanup to stop this?

How to uninstall Homebridge Docker on synology?

My Synology Docker application won't run currently after the new DSM update - I am going to try and uninstall Docker and reinstall it but want to keep all my Docker container configurations, etc.

When I go to uninstall Docker it says "Homebrdige Docker is dependent on this package. Please uninstall Homebridge Docker first before uninstalling the package" - but I can't see the Homebridge Docker app in the installed packages directory.

Is there a way to uninstall the pkg yet keep my Homebridge configuration working after reinstalling Docker? I don't want to redo all the setup of Homekit/Homebridge especially with all the automations I have made.

I'm hoping I can just remove the pkg and the Docker container config will still survive - I presume this pkg makes the docker compose for the user, but afterward it isn't needed and removing won't affect the container?

Socket Closed

Thanks for your great work with this package.

Everything was working as expected (no config changes), until I recently attempted to access the Terminal within a Container. I get the error 'Socket Closed'. Is there anything that might be causing this?

Not working when using a certificate

The web UI doesn't seem to work when using a Synology with a custom domain and certificate set up on it. The Homebridge app opens in a new tab at domain.com:8581 but the browser says it can't establish a secure connection.

How to update node to 12

It it possible to update this package to node 12? If so, how do we do it?

multiple instances?

Is there an easy way to use multiple instances of this SPK (use it more then once) or of multiple instances of Homebridge inside the docker image?

Homebridge Not Running

Hi, I have installed Homebridge again on a new Synology Diskstation. It has seemingly picked up my previous config.json file and other settings, but doesn't seem to be working correctly as the Homebridge UI reports 'Homebridge Not Running'. It's been a few years since I originally installed Homebridge so I've probably forgotten something, but I followed my notes from last time round and still can't see what Im doing wrong.

Any help much appreciated.

How to reset password.

How do I reset the password?

Safari can't connect to (ipaddressof disk station):8581

I get the following error message when trying to start Homebridge on my disk station. Any ideas as to what I haven't done, or not done correctly. The installation seemed to go correctly as far I can tell, and I have Docker installed and can see the image and container.

Safari can't open the page .0.1.:8581, because Safari can't connect to the server .0.1.

Many thanks for any help!

Visible via Bonjour but can't connect to HomeBridge

Thank you for your work on this!

I'm having an issue to connect to HomeBridge on the Home app.
I can't properly diagnose why, the logs look fine, no errors. The ports are not blocked by the firewall, I also see it when I do a lookup on Bonjour (_hap._tcp.). But I do not see it on the Home app, and scanning the QR Code brings an error.

Any idea on what I might be missing?

Can't connect to the UI

I've installed the package, it's running, when I click the icon a new tab with URL opens but it seems the server is not running.
I had the package installed at the beginning of your development when I got the wizard and all, then uninstalled it and reinstalled today - no wizard and this. Should I remove some files or something? Maybe the config changed or whatever?

/dev/ttyUSBx

First of all, great job. You made things easy for those who have a synology and want to run Homebridge in a docker.
Is there a way that you can create a serial port (or usb) mapping (option) available for those who use plug-ins who read the serialport. Like plug-in - Homebridge P1

Upgrading to 1.1.2 kills bonjour

Hi there,
I installed this on my Synology DS1815+ NAS ... Package went in as Homebridge 1.1.1
Bonjour saw the application happily, showing it to be on IP 192.168.1.1 (NAS LAN IP).

I saw there was an update to 1.1.2 pending, so I updated.

Now Bonjour shows the application on IP 172.17.0.1 - which is NOT my LAN... I'm assuming it's the IP for the internal Docker LAN?

Obviously - this will cause issues with anything seeing it on Bonjour and then trying to connect to it and there will be no obvious router to that network outside of the NAS itself.

Homebridge/Docker overwrites DNS name / clears mDNS name of Synology NAS

As this happens on my Synology NAS, I'm reporting this bug here.
But I'm not sure if this is the correct place/repository as this is probably Homebridge/Docker-related and not originating from the Synology SPK. I can replicate the bug report in the appropriate place if needed.

The Synology NAS is running DSM 6.2.3-Update2 with the latest Docker package.

--

Homebridge, installed in Docker via the Synology SPK, started to overwrite the DNS Name / delete the mDNS name of the NAS after the latest Homebridge/Docker update (v1.2.4, initiated via the Homebridge web GUI).

Please see following two attached screenshots showing a LAN scan (Hostname, DNS Name, mDNS Name columns).

↑ Fig. 1 – correct behaviour

Hostname reflects the Server Name setting in DSM (please see third screenshot), DNS name is correct (fritz.box is the local domain provided by the router), mDNS name is shown

↑ Fig. 2 – incorrect behaviour

Hostname is uppercase, DNS name is the Homebridge identifier, mDNS name is gone

↑ Fig. 3 – Synology DSM Control Panel Server Name setting

If I re-set the Server Name in the Network > General settings of the DSM Control Panel, the Hostname, DNS Name and mDNS name are correct again, only to be overwritten by Homebridge after a certain amount of time. (Usually within 1-5 minutes, I can not determine a consistent timeframe or event when this is triggered.)

ffmpeg Problem

Hi,

thanks for this spk. Homebridge Installation has never been so effortless…
I´m having an issue with the homebridge-camera-ffmpeg module.
I have enabled ffmpeg via environment variable. (PACKAGE…) an everything seems normal.
But my iOS-Home-App an Eve won´t show any Device…

Any clues?

Thank you,

Stefan

Query on multiple instances

Hi,

I've been running a single instance of the homebridge docker on the Synology for some time and am able to run multiple instances of homebridge on the Raspberry PI (with multiple systemd services - no docker).

I was wondering about running multiple instances of docker'd homebridge on synology. Obviously, I'll need to create new shared folders under /volume1/docker and launch multiple containers of the same image with different parameters (port number etc.) and install the appropriate plugins for each container.

But what about the Homebridge Config UI app, can you have several instances?

Thx

No internet connection from homebridge

When I start the homebridge I don't get an internet connection. What am I doing wrong?
There is no firewall enabled on the Synoloy NAS and it connects to the internet without any problems.

Homebridge folder on Synology is empty

.

EADDRINUSE 0.0.0.0:9999

Hi, homebridge works at the first time run perfectly, after restart I will get the EADDRINUSE error. I have to install Homebridge (docker container) again to get working until next restart after installing some plugins.

How to solve this problem?

Thanks and nice work!

Since DSM 6.2.2-24922 Update 3 homebridge-syno-spk 1.0.7 is no longer running

Please see this issue for solution: homebridge/docker-homebridge#227

---

Since 08/28/2019 the homebrigde-syno-spk in version 1.0.7 is no longer running on Synology DSM. Synology Update DSM 6.2.2-24922 Update 3.

http://192.168.xx.xx:8581 can't connect. Still someone has the same problem?

Nico

Suddenly slow as heck?

I've had Homebridge installed in this way for over a year now, I think. Always amazing, super speedy loading into the home app, one of the fastest to update. But lately it has gotten to the point where it can take half a minute to refresh. Do you have any tips, tricks or recommendations on cleaning up the install? Clearing old caches etc. It really isn't as snappy and I don't necessarily want to just reinstall and re-set up all my devices, scenes and automations. Thanks for the great work on such a nice piece of software!

problem of detecting homebridge on iPhone

Hello I installed them well everything is ok but I can't detect the home brige on the iphone can you help me

This package removed my existing homebridge installation without any warning

There was no warning that my existing docker container named "homebridge" will be removed. During the installation I have lost my backup!

The script should perform some checks if container to be removed was created by e.g. previous installation of this package or issue warnings that any containers with this name will be removed.

Migrate to this from old docker install

What is the proper method of migrating from the old method to using this? This method seem to be easier to update.

I've tried installing this and hoping it would see my existing files (plugins and config). However, once installed, this process will not launch and I can't determine the reason.

Thanks,
Dave

have to reinstall if docker share is moved

probably not a major issue, but the full path to the homebridge config is specified at install using absolute paths ie /volume1/docker/homebridgeconfig

if the shared folder that hosts the config is moved to another volume on the synology, the container doesnt start.

is it possible to put that in an environment variable, or make it easier to change after the fact? or is the docker / container ethos to blow it away and rebuild when changes are needed, if so then ignore :)

Workaround --

1. remove the homebridge package (this should leave the homebridge config in place - backup anyway before u do this !)
2. do the install again with the .spk file downloaded
3. at install, specify the volume where the docker share is now ie /volume1 or volume2 or volume3 etc

Using secondary LAN interface

Is there a way to tell Homebridge (or Docker) to use my secondary LAN interface? I have 2 ethernet connections for my synology, which add it to two different VLANs. I would prefer Homebridge use the non synology default LAN.

Can no longer start the package 'Container Does Not Exist'

I have no idea what happened, but I rebooted my synology DS918+ and I can no longer load the Homebridge Package. If I try to start the package I get an error saying 'Homebridge failed to start'. If I go into docker and try to run the Container I receive a message stating 'Container Does Not Exist'.

I've removed the homebridge directory and uninstalled/re-installed the package multiple times.

I am on docker 17.05-0370 and PHP 7.028-0025.

Like I said, I have no idea what happened.

DSM Update

Good evening,
I am facing issues after the latest DSM Update 6.2.2-24922-1:
Homebridge service cannot be started anymore. Any ideas? Thank you!

Restart from Homebridge UI gets stuck, required to restart container

Allow to pass parameters to the command line

I need to run a plugin in a debug mode - would be great to provide command line params, eg.

DEBUG=homebridge-weather-station-extended

Synology DS3018xs

hi, I cant seem to install this on my DS3018xs, it says the platform is not supported.
please help. thanks!

Seems like the package is running in Info or even Debug log level

I'm getting lots of informational messages in my log. I don't see where the log level is set -- is it possible that the log level is set to Debug or Info?

I get messages like this every couple of seconds...

[1/8/2020, 1:52:06 PM] [Rpi] raspberrypi: set Load from 0.35 to 0.27
[1/8/2020, 1:52:21 PM] [Rpi] raspberrypi: set Current Temperature from 24.5°C to 23.9°C
[1/8/2020, 1:52:21 PM] [Rpi] raspberrypi: set Load from 0.27 to 0.28
[1/8/2020, 1:52:36 PM] [Rpi] raspberrypi: set Current Temperature from 23.9°C to 24.5°C
[1/8/2020, 1:52:36 PM] [Rpi] raspberrypi: set Load from 0.28 to 0.29
[1/8/2020, 1:52:51 PM] [Rpi] raspberrypi: set Load from 0.29 to 0.3

thanks

Installing wpietri/sucks

I am not sure who to ask, but I thought I would start here. I am trying to install wpietri/sucks so I can automate my robot vaccum with the cmdswitch2 plugin. What are the steps to doing that on the Synology and with your package? I tried the apk add method but that didn't work. Any help or direction would be greatly appreciated.

No SSL

Hi,

Is it possible to use SSL with the Synology package?

Best regards,

Marco

«node-gyp rebuild» error when installing plugin

Hi, I have homebridge running on a Synology NAS using the oznu installation that allows installing plugins through the browser interface. When trying to install, I do get the error "node-gyp rebuild" and so on (see below). Is there any way to run the "% apt-get install libpcap-dev" and "% sudo npm install -g homebridge-platform-ring-video-doorbell" commands to install the ring plugin when running homebridge this way?