Code Monkey home page Code Monkey logo

homebridge-synology's Introduction

Homebridge-Synology

Package Quality

homebridge-plugin. Control your Synology Diskstation with Apple-Homekit.

supports DSM 5.x and 6.x

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

config.json

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 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", // the name is displayed in homekit
            "ip": "192.168.178.1", // ip of your diskstation
            "mac": "A1:B3:C3:D4:E5:EX", // mac of your diskstation
            "port": "port number", // (optional) port number of the webinterface, default 5000 (or 5001 if you set secure=true)
            "secure": false, // set this to true if you use a secure connection (https)
            "account": "admin",
            "password": "supersecret",
            "version": 5, // (optional) DSM Version, default is 6
            "timeout": 5000, // (optional) in ms, increase this value for slow diskstations
            "disabled": ["temp"], // (optional) see "disable services"
            "doPolling": true, // (optional) default is false
            "pollingInterval": 60 // (optional) in s, default is 60
        }
    ]
}

Disable services

You can disable services of your Synology accessory. Add a disabled property with an array to your config.json. You can add the following parameters:

  • temp to disable the temperature
  • stats to disable the custom characeristics cpu load and disk usage quote.
  • switch to disable shutting down the Synology.

Note This accessory will only appear as switch at the Apple Home App. Use the EVE App instead to get all services.

Two factor authentification (2FA)

This plugin does not support 2FA. If you have enabled 2FA, you can't use this plugin.

Functions

  • wake up (wake-on-lan has to be active) your diskstation
  • shutdown your diskstation
  • get the current system or average disk temperature
  • get the current cpu load
  • get the disk usage quote (it is the average usage if you have more than one volume)

Issues

Please double check your config.json before opening an issue. When you open an issue provide a detailed description of your problem and add your config.json (without password).

Roadmap

  • Polling feature with ping

support

PRs are always welcome. You can also support me with a coffee Buy Me A Coffee

homebridge-synology's People

Contributors

mbierman avatar stfnhmplr avatar tekuonline avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.