ioBroker Synology adapter

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

Description

The driver allows you to receive data and manage your Synology NAS server.

2FA Settings

If you use 2FA in DSM6/7 see instructions here

Important note for Windows Installations

This adapter requires git to be installed at the hist system. Installation media can be found at https://git-scm.com/download/win.

Reboot and Shutdown

The adapter will do this via SSH since v2.1.4, so please set the SSH port in the adapter setttings. You can see it in the Synology settings:

sendMethod

You can send any command (method) by setting the sendMethod object, for example: Get the SurveillanceStation info is a getInfo method with no additional parameters.

{"method": "getInfo", "params": {}}

Control

commands.reboot - reboot NAS

commands.wake - send Wake On Lan to NAS

commands.shutdown - shutdown NAS

SurveillanceStation.cameras.{NAMECAM}:

• enabled - Current status and enable/disable camera
• linkSnapshot - URL for snapshot

SurveillanceStation.HomeMode.status_on - Current status and enable/disable homemode

SurveillanceStation.getSnapshotCamera - Get snapshot by camera number, the file is saved in a directory ...iobroker-data\synology_0\snapshotCam_2.jpg

AudioStation.players.{PLAYERID}:

• play, pause, stop, next, prev - Controlling playback (button, only true)
• repeat - Repeat control (Off, All, One)
• shuffle - Shuffle control (true/false)
• volume - Volume remote player (0-100)
• seek - Controlling playback seek (0-100)
• play_folder - Add tracks from the folder to the playlist (id folder e.g. dir_5816)
• play_track - Play track by its id (e.g. music_120847)
• current_play - Control and status of the current track by its number in the playlist (e.g. 14)

DownloadStation:

• activeTask - number of incomplete downloads
• listTasks - an array with incomplete downloads
• shedule_enabled, shedule_emule_enabled - Status and control of scheduled or immediate downloads
• add_hash_download - add to Hash Downloads (e.g. 8BD3CAD02FC9ECB661A12378414FA310D3F3FE03)
• add_url_download - add download URL or magnet link
• folder - The folder to download, set before adding the download, otherwise it is loaded into the default folder
• pause_task, resume_task - Pause the download and resume. (e.g. dbid_170 or 170 or all)

Messagebox

sendTo('synology.0', 'getSnapshot', {camId: 2}, (res) => {
    if(res) sendTo('telegram.0', {text: res, caption: 'caption for image'});
});

Changelog

3.1.0 (2024-04-07)

• (mcm1957) Adapter requires node.js 18 and js-controller >= 5 now
• (mcm1957) Dependencies have been updated

3.0.1 (2023-10-01)

• (Standarduser) A Typo in RegEx for Mac-Address has been corrected.
• (McM1957) Dependencies have been updated.

3.0.0 (2023-09-07)

• (Standarduser) Added WOL to awake Synology NAS server
• (bluefox) Only node 16 or higher supported

2.1.13 (2022-11-05)

(McM1957) Code has been prepared for upcoming js-controller release. Reference to utils.controllerDir has been removed. (#198) (McM1957) Several base modules have been updated.

2.1.12 (2022-10-26)

*(McM1957) Logging of password in clear text has been removed.

2.1.11 (2022-10-24)

*(McM1957) The adapter has been adapted to be compatible with node14.

2.1.10 (2022-10-23)

(McM1957) Handling of passwords containing special characters (i.e. a dollar sign) has been fixed (#180) (McM1957) Base modules have been updated as suggested by dependabot.

2.1.9 (2022-07-01)

• (Apollon77) Try to prevent account locks when using 2FA on restarts of the NAS

2.1.8 (2022-06-12)

• (Apollon77) slow down reconnects to the DSM

2.1.7 (2022-04-26)

• (Apollon77) Try to prevent account locks when using 2FA on restarts of the NAS

2.1.6 (2022-04-04)

• (Apollon77) Fix 2FA

2.1.5 (2022-04-03)

• (Apollon77) fix DSM version detection

2.1.4 (2022-04-03)

• (arteck) workaround for shutdown and reboot(configure your ssh port in the settings)
• (Apollon77) prevent error when setting FileStation.info.items on start once

2.1.1 (2022-03-26)

• (Apollon77) Optimize object type determination and adjustments

2.1.0 (2022-03-25)

• IMPORTANT: You need to re-enter the password once after installing this version!
• (Apollon77) Camera snapshots are now also stored in ioBroker storage to be easier used in visualizations!
• (foxriver76) Hide password display in Admin when using Admin5
• (Apollon77) Fix volume description
• (Apollon77) Fix type issues since js-controller 3.3

2.0.1 (2021-09-17)

• (MeisterTR) Workaround JSON config Password

2.0.0

• (instalator) DSM7 support

1.1.3 (2021-08-23)

• (MeisterTR) Fixed 2FA

1.1.2 (2021-08-12)

• (MeisterTR) Fixed datatypes
• (MeisterTR) added new ConfigJson (if you use 2FA pleease retype in config)
• (MeisterTR) Fixed snapshot again

1.1.1 (2021-08-09)

• (MeisterTR) fix type of uptime
• (MeisterTR) fix broken snapshot link

1.1.0 (2021-08-07)

• (MeisterTR) fixes for DSM7
• (MeisterTR) added release-script
• (MeisterTR) change testing
• (MeisterTR) change syno repo to default

1.0.1

• (thost96) fix for wrong type number issue 78

1.0.0

• (instalator) changed name objects in hdd_info issues 51
• (Apollon77) BREAKING CHANGE: Please set password new in admin!
• (Apollon77) js-controller 3.0 is now needed minimum!
• (Apollon77 store password now encrypted)

0.1.20

• (instalator) fixed error

0.1.18

• (instalator) change link for album cover

0.1.17

• (instalator) added Sentry plugin support

0.1.16

• (instalator) fixed error

0.1.15

• (instalator) fixed error in parse Info
• (instalator) fixed api undefined

0.1.14

• (instalator) fixed missing datapoints
• (instalator) refactoring
• (instalator) Changed the logging of some errors
• (instalator) Changed format session in syno package

0.1.11

• (instalator) added motionDetected state
• (SpectreKr*) Adding to FS Sharing

0.1.10

• (instalator) fixed copy cover file
• (instalator) fix get packages for DSM 5.x
• (instalator) Added option to select services for receiving data

0.1.8

• (instalator) fix error addDownload
• (instalator) fixed listRadios
• (instalator) fixed get cover

0.1.7

• (instalator) fixed 2FA
• (instalator) Added setup guide 2FA

0.1.6

• (instalator) fix for 2fa
• (instalator) fix error
• (instalator) change error log
• (instalator) fix io-package
• (instalator) fix error status player

0.1.4

• (instalator) change for DownloadStation
• (instalator) added playlist favorite radio
• (instalator) added clearPlaylist button
• (instalator) refactoring

0.1.3

• (instalator) change obj for ss info fix for cover song
• (instalator) fix for info.connection
• (instalator) add 6.2.3 fix for player browser files
• (instalator) fix for 2FA
• (instalator) fixed error add download
• (instalator) added DownloadStation task list

0.1.2

• (instalator) fixed error

0.1.1

• (instalator) added messagebox for snapshot
• (instalator) update readme
• (instalator) added ss link for different streams
• (instalator) fix error
• (instalator) refactoring

0.1.0

• (instalator) added HomeMode switch
• (instalator) change for audiostation
• (instalator) change for as and ss
• (instalator) added snapshot functional
• (instalator) fixed systemConfig
• (instalator) fixed many error

0.0.4 (2018-10-07)

• (instalator) Изменен репозиторий библиотеки
• (instalator) Добавлено в конфиг время опроса

0.0.3 (2018-01-03)

• (instalator) initial

License

The MIT License (MIT)

Copyright (c) 2024, iobroker-community-adapters iobroker-community-adapters@gmx.de Copyright (c) 2021-2023 instalator vvvalt@mail.ru, ioBroker Community-Developers

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.