homebridge-synology
    TypeScript icon, indicating that this package has built-in type declarations

    0.4.2 • Public • Published

    project

    🧐 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.

    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

    • 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"]. If you disable the switch functionality, you can't start or stop your diskstation anymore.

    🛡️ License

    This project is licensed under the MIT

    Install

    npm i homebridge-synology

    DownloadsWeekly Downloads

    113

    Version

    0.4.2

    License

    MIT

    Unpacked Size

    24.6 kB

    Total Files

    13

    Last publish

    Collaborators

    • stfnhmplr