This MagicMirror module, display Synology Download Station tasks.
None compacted mode : bottom_center
Compacted mode : bottom_left
- An installation of MagicMirror2
- synology-api
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.
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.
}
},
]The following properties can be configured:
| Option | Description |
|---|---|
host |
Synology Hostname/IP. Required Possible values: localhost, url or a IPDefault value: null |
port |
Synology port. Default value: 5000 (Default Synology port) |
user |
Synology account. Required Default value: null |
passwd |
Account password. Required Default value: null |
refreshInterval |
The refresh interval (in seconds). Default value: 10 |
maxItems |
Maxium number displayed tasks Possible values: numericDefault value: 5 |
compactMode |
The size of module is reduced. Number of caracters of the task name is limited by compactMaxLenRecommended for: top_left, top_right, bottom_left, bottom_right, bottom_center, middle_centerPossible values: true or falseDefault value: true |
compactMaxLen |
Maximum number of caracters of the task name Possible values: numericDefault value: 30 |
textSize |
Possible values: xsmall, small, medium, large, xlargeDefault value: xsmall |
iconSize |
Size of FontAwesome icons Possible values: xsmall, small, medium, large, xlargeDefault value: small |
msgEmptyList |
Display message when no tasks on Download Station Possible values: Any string you want! Default value: No task |
Additional settings are available to :
- Display / hide columns
- Display / hide tasks (by status)
The displayColumns property contains the list of each column you can display/hide
| Option | Description |
|---|---|
id |
Display task ID (used for debug) Possible values: true or falseDefault value: false |
status_icon |
Display task status (FontAwesome icon) Possible values: true or falseDefault value: true |
status |
Display task status (text) Possible values: true or falseDefault value: false |
title |
Display task title Possible values: true or falseDefault value: true |
size |
Display size of download task Possible values: true or falseDefault value: true |
percent_completed |
Display percentage download completed Possible values: true or falseDefault value: true |
download_icon |
Display download speed icon Possible values: true or falseDefault value: true |
speed_download |
Display download speed value Possible values: true or falseDefault value: true |
upload_icon |
Display upload speed icon Possible values: true or falseDefault value: true |
speed_upload |
Display upload speed value Possible values: true or falseDefault value: true |
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
}
},
]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)
| Option | Description |
|---|---|
finished |
Finished task (download completed, but not seeding) Possible values: true or falseDefault value: true |
downloading |
Download in progress Task Possible values: true or falseDefault value: true |
waiting |
Waiting task (Download will start shortly) Possible values: true or falseDefault value: true |
hash_checking |
Checking current task integrity Possible values: true or falseDefault value: true |
paused |
Paused task Possible values: true or falseDefault value: true |
seeding |
Download completed, sharing. Possible values: true or falseDefault value: true |
error |
Error task Possible values: true or falseDefault value: true |
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
}
},
]
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent