stfnhmplr / homebridge-synology

Control your Synology Diskstation with Homekit
MIT License
161 stars 15 forks source link
diskstation homebridge homebridge-plugin synology

project

🧐 Features

If you would like to support me or the further development, please consider buying me a coffee.

Buy Me A Coffee

🚀 Installation

Follow the instruction in NPM for the homebridge server installation. The plugin is published through NPM and should be installed "globally" by typing:

sudo npm install -g homebridge-synology

🛠️ Configuration

Edit your config.json and add a new accessory. Example:

{
    "bridge": {
        "name": "Homebridge",
        "username": "CC:22:3D:E3:CE:51",
        "port": 51826,
        "pin": "031-45-154"
    },
    "description": "This is an example configuration file for the homebridge synology plugin",
    "hint": "Always paste into jsonlint.com validation page before starting your homebridge, saves a lot of frustration",
    "accessories": [
        {
            "accessory": "synology",
            "name": "Diskstation",
            "host": "192.168.1.1",
            "mac": "A1:B2:C3:D4:E5:F6",
            "port": 5000,
            "protocol": "http",
            "username": "your-username",
            "password": "your-password",
            "version": "6.2.2",
            "otp": "otp-code for 2FA",
            "startupTime": 60,
            "shutdownTime": 60,
            "disabled": [],
        }
    ]
}

Some explanations

🛡️ License

This project is licensed under the MIT