Category: Operations. Tags: Numbers and metrics, Charts and gauges, Factories and warehouses, Offices and workplaces.
Previews
Views and forms
Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.
Card views, themes and publishing. Browse the gallery.
Data and privacy
This card uses its configured properties and live card 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 | "Energy now" | maxLength: 40 | |
co2Factor | number | 0.4 | minimum: 0; maximum: 2 | Kilograms of CO₂ avoided per kWh generated, used when co2SavedKg is not given. |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
solarKw | number | minimum: 0 | Solar generation now, in kW. | |
loadKw | number | minimum: 0 | Consumption now, in kW. | |
batteryKw | number | Battery power in kW: positive charges, negative discharges. Leave out, with batteryPct, when there is no battery. | ||
batteryPct | number | minimum: 0; maximum: 100 | Battery charge, 0 to 100. | |
gridKw | number | Grid power in kW: positive imports, negative exports. Derived from the other flows when left out. | ||
generatedTodayKwh | number | minimum: 0 | Energy generated so far today, in kWh. | |
co2SavedKg | number | minimum: 0 | CO₂ avoided, in kg. Computed from generatedTodayKwh and co2Factor when left out. | |
footnote | string | "" | maxLength: 80 |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "energy",
"primitive": "card",
"card": "energy",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "energy-main"
}Write live data
Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.
curl --request PUT "https://api.screenrig.ai/api/card-data/energy-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"solarKw":1,"loadKw":1,"batteryKw":1,"batteryPct":1,"gridKw":1,"generatedTodayKwh":1,"co2SavedKg":1,"footnote":""}}'