README.md

MMM-qnapDownloadStation

A module for the MagicMirror project (https://github.com/MichMich/MagicMirror) to display the downloads of the QNAP Download Station

Columns, and headings, as well as how some of the data is displayed is configurable and the inside icon are configurable.

Installation

Clone this repository in your ~/MagicMirror/modules/ folder ( $ cd ~MagicMirror/modules/ ):

git clone https://github.com/flick116/MMM-qnapDownloadStation

Dependencies

request

Note

I have only tested this on a QNAP TS-351 running Download Station 5.

Config

Option	Required	Description
username	Yes	This is your QNAP Download Station username. Type: string
password	Yes	This is your QNAP Download Station password. Type: string
qnapServer	Yes	The web address to your QNAP NAS, in the format http://xx.xx.xx.xx or http://servername Type: string
loginUrl	No	Sets the login URL used as part of the login process, if different from the default. Type: string Default value: /downloadstation/V4/Misc/Login
queryUrl	No	Sets the query URL used as part of the login process, if different from the default. Type: string Default value: /downloadstation/V4/Task/Query
status	No	Dictates what type of downloads are shown in the table. Type: string Possible values: downloading, seeding, finished, paused, stopped, completed, active, inactive, all Default value: downloading
fromNo	No	The download to start from, so if you set to 10 it will show from the 10th record. Type: string Default value: 0
limit	No	Determines the maximum number of downloads to show. Type: string Default value: 50
useHeader	No	Whether to show the table header. Type: bool Possible values: true or false Default value: true
headerName	No	Sets the header column for the download name. Type: string Default value: Name
headerDownRate	No	Sets the header column for the download rate. Type: string Default value: Down
headerUpRate	No	Sets the header column for the upload rate. Type: string Default value: Up
headerProgress	No	Sets the header column for the progress. Type: string Default value: %
headerStartTime	No	Sets the header column for the start time/date. Type: string Default value: Start
showDownRate	No	Determines whether to show the download rate column. Type: bool Possible values: true or false Default value: true
showUpRate	No	Determines whether to show the upload rate column. Type: bool Possible values: true or false Default value: false
showStartTime	No	Determines whether to show the start/date time column. Type: bool Possible values: true or false Default value: false
showProgress	No	Determines whether to show the progress column. Type: bool Possible values: true or false Default value: false
dateFormat	No	Sets the date/time format of date/time columns. Type: string Possible values: See https://momentjs.com/ Default value: DD/MM/YY, h:mm a

Example of the config.js entry:

		{
			module: "MMM-qnapDownloadStation",
			header: "QNAP Download Station",
			position: "top_right",
			config: {
				username: "admin",
				password: "password"
			},
		},