power_system_state_RTD: Power system state - real time data

In virmar/finnishgrid: 'Fingrid Open Data API' R Client

Power system state - real time data

Description

Check https://data.fingrid.fi/en/dataset/power-system-state-real-time-data

Usage

power_system_state_RTD(start_time = NA, end_time = NA, user_key = NA)

Arguments

start_time	Start time in UTC with offset. Character array in ISO8601, YYYY-MM-ddTHH:mm:ssZ
end_time	End time in UTC with offset. Character array in ISO8601, YYYY-MM-ddTHH:mm:ssZ
user_key	Character array holding API-key. Free from https://data.fingrid.fi/open-data-forms/registration/

Value

A data frame object that contains different states of the power system - traffic lights: 1=green, 2=yellow, 3=red, 4=black, 5=blue. The data is updated every 3 minutes.

Examples

## Not run: 
library(finnishgrid)
start = "2021-01-01T00:00:00+0200"  # UTC+2 offset, Helsinki time
end = "2021-01-10T00:00:00+0200"    # UTC+2 offset, Helsinki time
key = "MY_SUPER_SECRET"
df <- power_system_state_RTD(
    start_time = start,
    end_time = end,
    user_key = key)
summary(df)

## End(Not run)

virmar/finnishgrid documentation built on June 9, 2024, 5:57 p.m.