Skip to content

jannekalliola/MMM-FiElectricityPrice

Repository files navigation

MMM-FiElectricityPrice

Magic Mirror Module to display Finnish electricity prices from Nord Pool. The module can be used to show data from other regions from Nord Pool, but I have not tested it with them.

The module loads the electricity prices when started and then every day at 16:01 local time of your MagicMirror installation. The prices are shown as a bar chart with optional average value and highlights for high and low prices, both limits are configurable.

The module reads the data that is shown on this page: https://www.nordpoolgroup.com/en/Market-data1/Dayahead/Area-Prices/FI/Hourly/?view=table

Screenshot

Installation

Clone this repository in your modules folder, and install dependencies:

cd ~/MagicMirror/modules 
git clone https://github.com/jannekalliola/MMM-FiElectricityPrice
cd MMM-FiElectricityPrice
npm install 

Configuration

Go to the MagicMirror/config directory and edit the config.js file. Add the module to your modules array in your config.js.

Enter these details in the config.js for your MagicMirror installation:

    {
        module: "MMM-FiElectricityPrice",
        header: 'Electricity Price',
        position: "top_right",
        config: {
        }
    },

Module configuration

The module has the following configuration options:

Option Default Description
dataSource https://www.nordpoolgroup.com/ api/marketdata/page/35? currency=EUR The URL where to load the data. Nord Pool lists the available pages here: https://www.nordpoolgroup.com/api/marketdata/queries/
loadingMessage Loading Data... The message to be shown while the data is loaded from the Nord Pool API.
errorMessage Data could not be fetched. The error message to be shown if the data loading failed due to an error.
showPastHours 24 The amount of past hours to show.
showFutureHours 36 The amount of future hours to show.
hourOffset 1 The number of hours to offset the Nord Pool times that are given in CET/CEST. Value 1 corrects the time to Finland and the Baltics, 0 works for countries in the CET/CEST timezone, and -1 for countries in GMT.
priceMultiplier 1 The price will be multiplied with this multiplier. Useful for adding value added tax and like to the price. The priceOffset will be added after multiplication.
priceOffset 0 The amount of euro cents to add on top of the price. You can use this to add the transfer cost, comission and other costs to get the final price you are paying.
showAverage false Flag to control whether the average price over seven days (future and past) is shown as a line on top of the bars.
averageColor #fff The color of the average line. Hexadecimals and rgba values, such as rgba(255, 255, 255, 0.8), are allowed.
showGrid true Flag to control showing the grid lines.
gridColor rgba(255, 255, 255, 0.3) The color of the grid lines.
labelColor #fff The color of the axis labels.
tickInterval false The interval between ticks (hours on the grid). Default is false to use automatic algorithm. The calculation is based on the hour value, for example, 3 shows hours 0:00, 3:00, 6:00, etc., and 4 shows hours 0:00, 4:00, 8:00, etc.
pastColor rgba(255, 255, 255, 0.5) The border color of the past hour bars.
pastBg rgba(255, 255, 255, 0.3) The fill color of the past hour bars.
currentColor #fff The border color of the current hour bar.
currentBg #fff The fill color of the current hour bar.
futureColor rgba(255, 255, 255, 0.8) The border color of the future hour bars.
futureBg rgba(255, 255, 255, 0.6) The fill color of the future hour bars.
alertLimit false The limit in euro cents or average to set the lower limit for pricier hours. The limit is not used when the value is set to false.
alertColor rgba(255, 0, 0, 1) The border color of the alert hour bars.
alertBg rgba(255, 0,0, 0.8) The fill color of the alert hour bars.
safeLimit false The limit in euro cents or average to set the upper limit for inexpensive hours. The limit is not used when the value is set to false.
safeColor rgba(255, 0, 0, 1) The border color of the safe hour bars.
safeBg rgba(255, 0,0, 0.8) The fill color of the safe hour bars.
updateUIInterval 300 The interval, in seconds, to update the UI. Updating the UI does not fetch the data from the network again, it just draws the UI to change the current hour.

Changelog

2022-09-04 Initial version

About

Magic Mirror Module to display Finnish electricity prices from Nord Pool.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published