You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+17-10
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,16 @@
1
1
# MMM-covid19
2
-
Magic Mirror Module to display stats on Covid19.
2
+
Magic Mirror Module to display stats on Covid19.
3
3
Data is provided by _https://covid19api.com/_
4
4
5
5
The data shown in the table displays the total numbers (top) and the difference calculated on the last 24 hours of available data. Reference timezone is UTC.
6
6
7
+
## installation
8
+
This 3rd party module install just like any other.
9
+
This Magic Mirror Forum thread describe a step-by-step procedure to install: [How to add modules. For absolute beginners.](https://forum.magicmirror.builders/topic/4231/how-to-add-modules-for-absolute-beginners?_=1622723520331)
10
+
11
+
Check the configuration documentation below to ensure all set-up is done correctly.
12
+
13
+
7
14
## configuration
8
15
the default configuration looks like this:
9
16
```js
@@ -22,25 +29,25 @@ the default configuration looks like this:
22
29
}
23
30
```
24
31
25
-
-`countryCodes`: an Array of ISO2 values.
32
+
-`countryCodes`: an Array of ISO2 values.
26
33
A list cen be obtain at this url: https://api.covid19api.com/countries
27
34
28
-
-`world`: a boolean value (`true` or `false`).
35
+
-`world`: a boolean value (`true` or `false`).
29
36
Set to `true`it shows the world total numbers, it does not otherwise.
30
37
31
-
-`live`: a boolean value (`true` or `false`).
32
-
Set to `true`it shows the total numbers per country set in `countryCodes`, it does not otherwise.
38
+
-`live`: a boolean value (`true` or `false`).
39
+
Set to `true`it shows the total numbers per country set in `countryCodes`, it does not otherwise.
33
40
34
-
-`updateInterval`: a number in milliseconds to be used to refresh the numbers. Its value is only used when `useScheduler=false`.
41
+
-`updateInterval`: a number in milliseconds to be used to refresh the numbers. Its value is only used when `useScheduler=false`.
35
42
Its default values invokes an API call every 24 hours from starting from the first one.
36
43
37
-
-`useScheduler`: a boolean value (`true` or `false`).
44
+
-`useScheduler`: a boolean value (`true` or `false`).
38
45
Set to `true` it uses _cron_ like approach to refresh the data. It uses [`node-schedule`](https://github.com/node-schedule/node-schedule), in order to be able to use thi option, you need to run `npm install`
39
46
40
-
-`schedulerConfig`: a valid `node-schedule`configuration as a string or as an object.
47
+
-`schedulerConfig`: a valid `node-schedule`configuration as a string or as an object.
41
48
Its default value execute an API call _twice a day every day ad 12am and 12pm UTC time_.
42
-
43
-
49
+
50
+
44
51
The numbers shown are the delta between last day 00:00 UTC and the day before 00:00 UTC. The dates can be shown at the bottom of the list.
0 commit comments