This repository contains the source code for National Grid: Live.
Any officially supported versions of PHP and MySQL can be used.
Create a database and a user with SELECT, INSERT, UPDATE, and DELETE privileges, and import grid.sql into the database.
Copy configuration.php.example to configuration.php and enter the appropriate database connection settings into the PHP constants.
Configure the server to serve the contents of the public directory. Note that this directory contains only static files, so the web server does not need to support PHP.
Set up a cron job to execute the update.php script (using the PHP CLI SAPI) every five minutes. The cron job must run as a user with write access to public/favicon.svg and public/index.html.
The script outputs details of the update process to standard output, and details of errors to standard error. An error with an individual data source does not abort the rest of the update process. The APIs can be unreliable, so the ERROR_REPORTING_THRESHOLD constant in configuration.php is provided to control how many consecutive times an error must occur before it is reported.
The CSS refers to proza-light.woff2 and proza-regular.woff2. These are commercial fonts, so are not included in this repository. Licences for Proza can be purchased from Bureau Roffa. Alterenatively, the simplified free version Proza Libre can be used instead.
National Grid: Live uses Cloudflare’s content delivery network. Visit counts will be retrieved from Cloudflare if the CLOUDFLARE_API_TOKEN and CLOUDFLARE_ZONE_ID constants in configuration.php are set to non-empty strings. The Cloudflare API token must be configured to provide Analytics Read access for the zone.
PHP classes can be found in the classes directory. The Database class directly within this directory is responsible for all database access. The other classes are divided into three namespaces:
The Data namespace contains classes for reading data from the various data sources, as documented further below.
The State namespace contains classes representing the data needed to output the user interface. The State class is the overall container; an instance of this class is returned by the getState() method of a Database instance.
The UI namespace contains classes that output the user interface. The UI class has overall responsibility for outputting the HTML, while the Favicon class outputs the dynamically-updated favicon.
This API, developed by Elexon, reports power generation connected to the national transmission network, interconnector imports and exports, and pricing.
Data is available in XML format at 30-minute or 5-minute granularity. Only power generation (and not power consumption for pumping) is reported for pumped storage. Only the separate 30-minute interconnector data reports negative power generation for exports.
PHP classes: FiveMinuteGeneration, HalfHourGeneration, Interconnectors, Pricing
This API, developed by National Grid ESO and the University Of Oxford Department Of Computer Science, estimates the carbon intensity of electricity generation in grams of carbon dioxide per kilowatt-hour.
Data is available in JSON format at 30-minute granularity. Estimates may be retrospectively updated. Data is derived from the Balancing Mechanism Reporting System so outages occur whenever the BMRS has outages.
PHP class: Emissions
This API, developed by National Grid ESO, estimates power generation from embedded solar and wind (generation connected to the local distribution network rather than the national transmission network) and power consumption by pumped storage pumping.
Data is available in CSV format at 30-minute granularity. Estimates may be retrospectively updated.
PHP class: Demand
Battery storage data isn’t yet shown. The Balancing Mechanism Reporting Service includes several battery storage systems in its ‘other’ category, but only discharging is reported, in the same way as with pumped storage systems. While the National Grid ESO Data Portal offers an API reporting on pumped storage pumping, they don’t yet report on battery charging.
Elexon are in the process of testing a new API that will replace the Balancing Mechanism Reporting Service. Once this API has been finalised I’ll update the code to use it.
I’m not currently planning any other major changes. I believe it’s better for a project like this to have a limited scope and a concise interface serving the general public than to attempt to offer specialised analysis for energy industry experts.
