https://github.com/stfnhmplr/homebridge-synology

Control your Synology Diskstation with Homekit
https://github.com/stfnhmplr/homebridge-synology

diskstation homebridge homebridge-plugin synology

Last synced: about 13 hours ago
JSON representation

Control your Synology Diskstation with Homekit

• Host: GitHub
• URL: https://github.com/stfnhmplr/homebridge-synology
• Owner: stfnhmplr
• License: mit
• Created: 2016-03-09T21:11:14.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T09:31:08.000Z (almost 2 years ago)
• Last Synced: 2025-01-22T12:08:27.300Z (8 days ago)
• Topics: diskstation, homebridge, homebridge-plugin, synology
• Language: TypeScript
• Size: 555 KB
• Stars: 161
• Watchers: 19
• Forks: 15
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


## 🧐 Features

- Wake up (WOL has to be enabled) and shutdown your Synology Diskstation

- Get the current system temperature

- Supports 2-Factor-Authentication

- Configuration through homebridge-ui-x

**If you would like to support me or the further development, please consider buying 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:

```json

{

    "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

- **Version:** Your current DSM Version. **Important:** If you are using DSM version > 6.2.2 or DSM 7, enter `6.2.2` here anyway.

- **OTP (optional):** If you have enabled 2-Factor-Authentication, the code must be entered here. For more information, see https://github.com/iobroker-community-adapters/ioBroker.synology/blob/HEAD/docs/en/template.md

- **Startup and shutdown time (optional):** You can specify a duration for the startup and the shutdown process. During this time, there is no status change due to polling. Both defaults to 60s.

- **disabled (optional):** You can disable features. The services to be deactivated must be specified as an array of strings, such as `["switch", "temperature", "diskTemperature"]`. If you disable the switch functionality, you can't start or stop your diskstation anymore.

## 🛡️ License

This project is licensed under the MIT