Module: MMM-synology-ds

This MagicMirror module, display Synology Download Station tasks.

None compacted mode : bottom_center

Compacted mode : bottom_left

Dependencies

• An installation of MagicMirror²
• synology-api

Installation

Navigate into your MagicMirror's modules folder:

cd ~/MagicMirror/modules

Clone this repository:

git clone https://github.com/Thlb/MMM-synology-ds

Navigate to the new MMM-synology-ds folder and install the node dependencies.

npm install

Configure the module in your config.js file.

Using the module

To use this module, add it to the modules array in the config/config.js file.

modules: [
  {
    module: 'MMM-synology-ds',
    position: 'left_bottom',
    header: 'Download Station',
    config: {
      host: 'my.synology-ds.com',
      port: '5000', // Server port (not required if default port (5000) is used)
      user: 'account',
      passwd: 'password',
      refreshInterval: 10, // in seconds
      compactMode: true, // recommanded in left or right position.
    }
  },
]

Configuration options

The following properties can be configured:

Additional settings are available to :

• Display / hide columns
• Display / hide tasks (by status)

Additional configuration : Display / hide columns

The displayColumns property contains the list of each column you can display/hide

Example :

modules: [
  {
    module: 'MMM-synology-ds',
    position: 'left_bottom',
    header: 'Download Station',
    config: {
      host: 'my.synology-ds.com',
      port: '5000', // Server port (not required if default port (5000) is used)
      login: 'account',
      passwd: 'password',
      refreshInterval: 10, // in seconds
      compactMode: true, // recommanded in left or right position.
    
      displayColumns: {
          id: false, 
          status_icon: true, 
          statuts: false, 
          title: true, 
          size: true, 
          percent_completed: true, 
          download_icon: true, 
          speed_download: true, 
          upload_icon: true, 
          speed_upload: true
        }

   },
]

Additional configuration : Display / hide tasks

The displayTasks property contains the list of tasks status you can display/hide.

By default, all status are displayed. But, most important tasks will be displayed first :

Priority :

1. Error
2. Finished
3. Downloading
4. Hash checking
5. Waiting
6. Paused
7. Seeding (Task discarded if no upload in progress)

Example :

modules: [
  {
    module: 'MMM-synology-ds',
    position: 'left_bottom',
    header: 'Download Station',
    config: {
      host: 'my.synology-ds.com',
      port: '5000', // Server port (not required if default port (5000) is used)
      login: 'account',
      passwd: 'password',
      refreshInterval: 10, // in seconds
      compactMode: true, // recommanded in left or right position.
    
      displayTasks: {
          finished: true, 
          downloading: true, 
          waiting: true, 
          hash_checking: true, 
          paused: true, 
          seeding: true,
          error: true
      }
   },
]