Home status card

Show the security state, doors and locks, lighting and who is home in one view. Unknown readings stay explicit, and the card shows an alarm only when the supplied security state says triggered. This card displays data; it sends no security or lighting commands.

Live card

This card is drawn in your browser by the same code the Players run, with sample data.

Category: Operations. Tags: Numbers and metrics, Alerts and status.

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.

Household presence and security details belong on private screens. Data is supplied by the project; no location is collected by the card.

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
`pageSeconds`	integer	`12`	minimum: `8`; maximum: `120`

Dynamic properties

Name	Type	Default	Values and limits
`title`	string	`"Home, at a glance"`	maxLength: `80`
`subtitle`	string	`""`	maxLength: `160`
`footnote`	string	`""`	maxLength: `240`
`securityChangedAt`	string	`""`	maxLength: `40`
`securityState`	string	`"unknown"`	`"unknown"`, `"disarmed"`, `"armed-home"`, `"armed-away"`, `"triggered"`
`doors`	array	`[]`	maxItems: `20`
`doors[].name`	string		minLength: `1`; maxLength: `60`; Required
`doors[].state`	string	`"unknown"`	`"open"`, `"closed"`, `"unknown"`
`doors[].locked`	boolean, null	`null`
`lights`	array	`[]`	maxItems: `20`
`lights[].name`	string		minLength: `1`; maxLength: `60`; Required
`lights[].on`	boolean, null	`null`
`lights[].brightness`	integer, null	`null`	minimum: `0`; maximum: `100`
`people`	array	`[]`	maxItems: `12`
`people[].name`	string		minLength: `1`; maxLength: `60`; Required
`people[].presence`	string	`"unknown"`	`"home"`, `"away"`, `"unknown"`

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "home-status",
  "primitive": "card",
  "card": "home-status",
  "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:

{
  "title": "Home, at a glance",
  "subtitle": "",
  "footnote": "",
  "securityChangedAt": "",
  "securityState": "unknown",
  "doors": [],
  "lights": [],
  "people": []
}

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":{"title":"Home, at a glance","subtitle":"","footnote":"","securityChangedAt":"","securityState":"unknown","doors":[],"lights":[],"people":[]}}'