Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Tuxdiver/MMM-Rest
MagicMirror² addon for fetching REST data and displaying it on the mirror
https://github.com/Tuxdiver/MMM-Rest
Last synced: 23 days ago
JSON representation
MagicMirror² addon for fetching REST data and displaying it on the mirror
- Host: GitHub
- URL: https://github.com/Tuxdiver/MMM-Rest
- Owner: Tuxdiver
- License: mit
- Created: 2016-08-30T06:38:14.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-05-08T07:00:49.000Z (7 months ago)
- Last Synced: 2024-08-04T10:02:48.274Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 121 KB
- Stars: 19
- Watchers: 4
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-Rest**
README
# Module: MMM-Rest
The `MMM-Rest` module is a [MagicMirror²](https://github.com/MagicMirrorOrg/MagicMirror) addon.
This module collects data via HTTP calls and displays it on your mirror in a table.
## Installation
1. Navigate into your MagicMirror's `modules` folder and execute `git clone https://github.com/Tuxdiver/MMM-Rest`
2. cd `cd MMM-Rest`
3. Execute `npm install` to install the node dependencies.
## Changelog
- 2016-10-27: incompatible changes: the "suffix" and "digits" parameters are removed and replaced by a "format" parameter! Please check your config!
- 2018-02-02: added ranges to format parameter
- 2024-03-21: added the ability to place multiple instances of the module into config files
- 2024-03-22: Added the ability to specify and customize display of DateTime objects
- 2024-03-22: Added the ability to transform REST results before displaying
- 2024-05-06: Added new optional variable `forceAlign` for more customizable alignment
## Using the module
To use this module, add it to the modules array in the `config/config.js` file:
````javascript
modules: [
{
module: 'MMM-Rest',
position: 'bottom_right', // This can be any of the regions.
// Best results in one of the side regions like: top_left
config: {
debug: false,
forceAlign: false,
mappings: {
on_off: {
true: 'on',
false: 'off',
},
temperature: {
1: 'cold',
2: 'warm',
3: 'HOT',
},
},
sections: [
{
format: '%.1f',
url: 'https://www.dirk-melchers.de/echo.php?text=22.54',
},
{
format: [
{ range: [, 10], format: '%d'},
{ range: [10, 20], format: '%d'},
{ range: [30, ], format: '%d'},
{ string: 'HOT', format: '%d'},
{ format: '%d'}
],
url: 'https://www.dirk-melchers.de/echo.php?text=59.1',
},
{
format: '%s',
mapping: 'temperature',
url: 'https://www.dirk-melchers.de/echo.php?text=2',
},
{
format: '%d',
url: 'https://www.dirk-melchers.de/echo.php?text=62.1',
},
{
format: 'Lights %s',
mapping: 'on_off',
url: 'https://www.dirk-melchers.de/echo.php?text=true',
},
{
format: [
{ dateOptions: { weekday: 'long', month: 'long', day: 'numeric', hour: 'numeric', minute: '2-digit', hour12: true }, format: '%s'},
],
url: 'https://www.dirk-melchers.de/echo.php?text=2024-03-22T00:11:05.000+0000',
},
{
format: [
{ range: [, 1000], format: '%d W'},
{ range: [1000, 1000000], format: '%.1f kW', transform: 'value/1000'}
{ format: '%.1f MW', transform: 'value/1000000'}
],
url: 'https://www.dirk-melchers.de/echo.php?text=10005',
},
],
output: [
['Livingroom','@1','@2'],
['Kitchen','@3','@4'],
['Fridge','@5'],
['Last Updated','@6'],
['Solar Production','@7'],
],
},
}
]
````
## Configuration options
The following properties can be configured:
Option
Description
sections
sections is an array of hashes for the REST endpoints to connect to
Option
Description
format
- If it is a string: sprintf() format
- Could also be an array of hashes. The array is processed from top to bottom and first match wins.
The last entry could be a default without "range". Leaving one value of the range empty means
"ignore this bound".
- You could use "string" instead of "range" to match the value against the parameter of the string.
- Finally, you could use "dateOptions" instead of "range" or "string" to specify that the expected
value is an ISO 8601 DateTime object (may work for other date formats as well, as long as
the javascript function `new Date()` takes that format), and describe what format you want the
date displayed in. Formatting options described here
https://stackoverflow.com/questions/3552461/how-do-i-format-a-date-in-javascript.
- You may also add a `transform` function to convert the value before displaying it. Use a string that
is a common mathematical function with the value of the raw REST data is `value`. E.g., `value/1000`
will divide the raw value by 1000 before displaying. Useful for converting units. Note: transform
happens after any range is matched.
mapping
Map the value againt a defined mapping
url
The url to call. It has to return a single integer / floating point value
mappings
mappings is an hash of hashes for the mapping of values to other values
Option
Description
NAME_OF_MAPPING
Name of mapping will be referenced by sections -> mapping
values
hash of key / values to map from / to
output
control the output table for the display.
Has to be a 2-dimensional array representing the rows and the columns
of the output
A cell containing a '@' followed by a number represents the section id (starting by 1) of the REST Urls
updateInterval
How often this refreshes
Example: 60000
Default value: 60000
initialLoadDelay
How long to wait for the first load
Example: 60000
Default value: 0
animationSpeed
Fadeover effect for dom updates
Example: 1000
Default value: 2000
forceAlign
Boolean. Describes the alignment behavior of the table
false will align description cells to the left and variable cells (e.g., @1) to the right.
true will align all cells in the leftmost column to the left and all other cells to the right.
Default value: false
debug
Log messages to Log.info / console
Example: true
Default value: false