powersys_state_RTD {finnishgrid}R Documentation

Power system state - real time data

Description

Different states of the power system - traffic lights:1=green, 2=yellow, 3=red, 4=black, 5=blue* Green: Power system is in normal secure state.* Yellow: Power system is in endangered state. The adequacy of the electricity is endangered or the power system doesn't fulfill the security standards.* Red: Power system is in disturbed state. Load shedding has happened in order to keep the adequacy and security of the power system or there is a remarkable risk to a wide black out. * Black: An extremely serious disturbance or a wide black out in Finland.* Blue: The network is being restored after an extremely serious disturbance or a wide blackout.The data is updated every 3 minutes.

Usage

powersys_state_RTD(start_time_utc = NA, end_time_utc = NA, user_key = NA)

Arguments

start_time_utc

Start time in UTC. Character array YYYY-MM-ddTHH:mm:ss.sssZ

end_time_utc

End time in UTC. Character array YYYY-MM-ddTHH:mm:ss.sssZ

user_key

Character array holding API-key. Free from https://data.fingrid.fi/en/instructions

Value

A data frame object with time series data having period 3 min and unit type no.

See Also

https://data.fingrid.fi/en/datasets/209

Examples

## Not run: 
library(finnishgrid)
start = "2024-06-01T00:00:00.000Z"  # UTC
end = "2024-06-03T00:00:00.000Z"    # UTC
key = "MY_SUPER_SECRET"
df <- powersys_state_RTD(start_time_utc = start,
         end_time_utc = end,
         user_key = key)
summary(df)

## End(Not run)

[Package finnishgrid version 0.2.0 Index]