Displays supplied grams of CO₂-equivalent per kWh, with optional renewable share and today’s hourly profile. Duration-weighted comparisons of complete future windows identify the lowest supplied window remaining in the local day. Unknown gaps stay unknown, with report freshness visible. Primetime styling adds a spring entrance and slow power-grid linework.
Live card
Category: Weather. Tags: Weather and environment, Numbers and metrics, Charts and gauges.
Layouts
This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.
Layouts: full. Forms: landscape, portrait.
Card layouts, themes and publishing. Browse the cards.
Data and privacy
This card uses its configured properties and live card data.
Regional energy forecasts only; no personal or meter data.
Properties
For theme, background, accent and position, see Common properties.
Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.
Static properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
title | string | "Grid carbon" | maxLength: 100 | |
staleMinutes | integer | 120 | minimum: 1; maximum: 1440 | |
windowMinutes | integer | 60 | multipleOf: 30; minimum: 30; maximum: 240 | |
lowThreshold | number | 100 | minimum: 0; maximum: 10000 | Display threshold only, in grams CO2-equivalent/kWh; not a provider classification. |
highThreshold | number | 400 | minimum: 0; maximum: 10000 |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
region | string | "" | maxLength: 120 | |
source | string | "" | maxLength: 120 | |
updatedAt | string | "" | maxLength: 64 | |
periods | array | [] | maxItems: 96 | Supplied intensity intervals; first matching interval wins. Missing coverage remains unknown. |
periods[].start | string | maxLength: 64; Required | ||
periods[].end | string | maxLength: 64; Required | ||
periods[].gramsPerKwh | number | minimum: 0; maximum: 10000; Required | ||
periods[].renewablePct | number, null | null | minimum: 0; maximum: 100 |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "carbon-intensity",
"primitive": "card",
"card": "carbon-intensity",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "example-key"
}
Write live data
The canvas example binds its data field to example-key. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with feed:.
Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.
Save the document as card-data.json. The CLI reads the document itself, with no wrapper:
{
"region": "",
"source": "",
"updatedAt": "",
"periods": []
}
screenrig card-data put example-key --file card-data.json
Or call the API directly. The API wraps the same document in a document field. An agent token already names its project, so no project header is sent; if you send ScreenRig-Project, it must match the token’s project. Supply your API authorization through the environment; see API authentication.
curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "Content-Type: application/json" \
--data '{"document":{"region":"","source":"","updatedAt":"","periods":[]}}'