Skip to content

Infin1te2021/MMM-HK-Observatory

Repository files navigation

MMM-HK-Observatory

License

A module for MagicMirror displaying Hong Kong 9-day Weather Forecast.

Based on Hong Kong Observatory Open Data API.

Screenshots

screenshot1 screenshot2
Default 9-day Forecast

Installation

cd modules
git clone https://github.com/Infin1te2021/MMM-HK-Observatory.git
cd MMM-HK-Observatory
npm install

Use this module

Add the code below to the modules array in the config/config.js file:

    modules: [
        {
            module: "MMM-HK-Observatory",
            header: "MMM-HK-Observatory",
            position: "top_right",
            config: {
                animationSpeed: 2000,
                updateInterval: 600000,
                maxForecast: 4,
                showFooter: true,
            }
        }
    ]

If you want to use mouse left click to display the "next" day forecast, remember to enable the cursor in main.css file. Which should be none as default.

html {
  cursor: default;
}

Configuration options

Option Type Default Description
animationSpeed int 2000 Time to display when startup [milliseconds] (2 second )
updateInterval int 600000 Frequency to update the forecast [milliseconds] (10 minutes )
maxForecast int 4 The maximum number of weather forecast day will be displayed by default
showFooter boolean true Last update time

About

This module is (a part of) my FYP

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors