Skip to content

About

Widget library for Homey Pro dashboards

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

179 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Widgetkeeper

Extra dashboard widgets for Homey Pro, made to sit naturally next to Homey's own with the same look and feel.

Widgetkeeper widgets on a Homey dashboard on a tablet

Contents: Widgets · Web dashboards · Dashboard examples · Colour style · Tile names · API key · Installation · Troubleshooting

Widgets

Every widget follows Homey's light and dark mode and is translated into all 13 of Homey's languages. Tap one for what it does and its settings.

Activity Dots
Many motion, contact and vibration sensors at a glance, as dots that change colour when active

Cameras
Two to six cameras in one grid of snapshots; tap one to watch it live

Charts
One or two charts of any value over the last hour, day or week, drawn like Electricity Overview's

Clock
The time and the date, with the weather now and today's high and low

Curtains
Curtains and blinds that open or close with one tap, with a slider for anything in between

Dashboard Shortcuts (web dashboards only)
Your other web dashboards as buttons in your colours and icons, a menu for every dashboard

Days Since
How long since the plants were watered or the filter changed, amber and then red when it's due; tap to reset

Device Quick Actions
Compact tiles that run a device's quick action with one tap

Device Values
Compact tiles that each show one value, such as a temperature, power or on/off

Electricity Overview
Live power use, hourly electricity prices and usage history on one card

Energy Price Strip
The electricity price now and the coming hours as small bars, green, yellow or red

Flow Buttons
Start flows with one tap: a round button in the colour and icon you pick, with the flow's name

Insights Heatmap
A week of one value (light, temperature, motion …) as a grid of weekdays and hours

Light Controls
Compact light tiles with brightness, colour and colour temperature: six lights in the space of three

Locks and Doors
One line that says whether every lock and door is locked and closed

Media
A speaker with its album art, mute, a volume that never overshoots and buttons for its sources

Notes
A note on a tile or a handwritten Post-it, typed in or written by your Flows

Room Health
Each room's temperature, humidity and air quality at a glance, turning yellow to red when something is off

Sensor Alarms
Tiles that show a sensor's alarm and turn red when one is on

Smart Stack
Several widgets in one spot, one at a time, with the one that matters brought forward

Spacer
Empty space of the height you set, to line up widgets across columns

Sparklines
Tiles with a small chart of a value over the last hour, day or week, with its lowest and highest

Thermostat Presets
Three one-tap presets for a thermostat, heat pump or air conditioner

Timers
Kitchen timers from one-tap presets, with a Flow card when one runs out

Value Matrix
Devices or rooms against the values you choose, in one table, each cell green, orange or red by its range

Variable Presets
Two to four one-tap buttons that set a variable to the values you pick, like Thermostat Presets

Variables
Compact rows to switch variables on and off or change a number or text, with the full name

Weather Forecast
The next 36 hours, hour by hour, from MET Norway (yr.no)

Activity Dots

Activity Dots on a Homey dashboard: dots lighting up as someone comes in through the front door, then tapped for the kitchen's motion and the open garage

Motion, contact, vibration and camera sensors as a grid of dots that light up while active. Tap a dot for its name and since when, such as Garage · Open since 18:17.

Settings: sensors, title, idle and active colours, colour style, time format.

Cameras

Cameras on a Homey dashboard

Your cameras as a grid of snapshots that refresh every few seconds (cameras with only a video stream show a still from it). Tap one to watch it live.

Settings: cameras, layout (a large camera at the top or bottom, or one per row), refresh interval, how long live view stays on, time format, rename tiles.

Charts

Charts on a Homey dashboard: the outdoor temperature as a line, and the power use as bars

One chart, two stacked, or two values on one chart (each with its own scale), of any value that Homey logs in Insights, drawn like Electricity Overview's charts. The value now sits at the top in the chart's colour. Tap a chart to see the value at that moment.

Settings: one chart, two stacked or two on one chart; per chart the value, time span (1 hour to 7 days), style (line with area, line or bars), colour, scale (fitted or from zero), below zero in yellow, smooth line and title; the values at the top; colour style.

Clock

Clock on a Homey dashboard

The time and the date in one tile, with the weather now and today's high and low from MET Norway, the Weather Forecast's data. The time follows your phone, tablet or browser (24 or 12 hours) unless you pick one, the date Homey's language.

Settings: show the weather, time format (automatic, 24-hour or 12-hour).

Curtains

Curtains on a Homey dashboard: an open curtain tapped closed, a closed one tapped open and sent back with a second tap, and a blind dragged most of the way up

Curtains and blinds as tiles: tap to open or close (the corner label says which), or use the slider for anything between. A tap while it moves sends it back.

Settings: devices, what a tap does halfway, inverted position (leave it off when the device's own invert setting already flips it), how close to the end counts as open or closed, state line, group by room, colour, colour style, rename tiles.

Dashboard Shortcuts

Dashboard Shortcuts on a web dashboard: Home ringed, with Energy, Security, Climate, Evening and Kitchen

For web dashboards only: your other web dashboards as buttons, each with a round icon in the colour and icon you pick; a tap opens that dashboard. The one you're on is ringed, so the same widget can go on every dashboard as a menu.

Settings: up to eight dashboards, each with a colour and an icon; 1 or 2 columns; colour style; rename tiles.

Days Since

Days Since on a Homey dashboard: a list of chores with a bar each, plants watered 6 days ago in amber with 1 day left, the vacuum filter 3 months in red and 2 days overdue, and the fish just fed with Undo

Counters for things you do every so often, such as watering the plants or changing the vacuum filter, in a list on one card. Each bar fills up towards the day the counter is due, with the time left under it; it turns amber, then red, after the days you set, and then shows how long it's overdue (+2 d). Tap a row when it's done to start again from Today (with Undo for a few seconds). Counters are kept on Homey by name, so every widget and screen with the same counter shows the same one.

Flow cards: Reset [counter], Set [counter] to [days] days ago, the trigger [counter] became overdue (even with no dashboard open) and the condition [counter] is overdue; the last two also take Any counter.

Settings: days only or days, weeks and months; colour style; up to eight counters, each with a name, an icon and the days until amber and red.

Device Quick Actions

Device Quick Actions on a Homey dashboard

Half-height tiles that run a device's quick action with one tap (on/off, lock, play/pause, a button), highlighted while it's on.

Settings: devices, active style, colour, colour style, rename tiles.

Device Values

Device Values on a Homey dashboard

Half-height tiles that each show one live device value, optionally with a second value of the same device beside the name, such as a room's humidity next to its temperature. Percentages can fill their tile by level, and the Flow card Set the tile colour of … to … colours a tile, such as a fridge going red when it's too warm.

Settings: up to six values, each with an optional second value; 3 or 2 per row; compact or pill tiles (like Sensor Alarms'); percentage fill and its limits; colour style; rename tiles.

Electricity Overview

Electricity Overview on a Homey dashboard

Live power use, the hourly price from yesterday to 12 hours ahead (with your tariffs and taxes from Homey Energy), the last 24 hours of usage and the cheapest hour ahead. Tap a chart to see its values. Works with a fixed price too, and shows solar export below zero.

Settings: power meter, live time span, prices, tariffs and taxes, usage history, smooth lines, lowest price in 12 h / 24 h, compact layout, colour style.

Energy Price Strip

Energy Price Strip on a Homey dashboard

The electricity price now, and the coming 12, 24 or 36 hours as small bars in one tile: green, yellow or red by each hour's level in its day, with a dot over the cheapest. Uses the Electricity Overview's prices and needs no meter.

Settings: hours ahead, colour by level, colour style, tariffs and taxes.

Flow Buttons

Flow Buttons on a Homey dashboard

Flows and Advanced Flows as rows with a round button in your colour and icon. Tap a row to start the flow. Needs an API key with Start Flows. The Flow card Set the button colour of … to … colours the buttons that start a flow, such as green while an e-bike charges; Default gives them their own colour again.

Settings: up to eight flows, each with a colour, an icon and an optional name; 1 or 2 columns; colour style.

Insights Heatmap

Insights Heatmap on a Homey dashboard

A week of one Insights value as a grid of days and hours: numbers such as light or temperature, or how much of each hour a sensor was on.

Settings: device and value, a title in place of the device's name, this week or the last 3–14 days, hours per column, colour, colour style, scale, legend.

Light Controls

Light Controls on a Homey dashboard: a light turned on, dimmed with the bar, and given a colour and a white

Six lights in the space of three of Homey's light cards. Tap a tile to switch it, drag or tap the bar to dim, and tap the colour button for colours and whites. Lights in a room can share one tile. With the Room's Moods palette, the colour button starts the room's Homey Moods instead (needs an API key with Set Moods).

Settings: lights, group by room, widen the last tile, what the bar's far left does, colour palette, colour style, rename tiles.

Locks and Doors

Locks and Doors on a Homey dashboard

Locks, doors, windows and garage doors in one line: All locked and closed, or what isn't, on a red tile. Tap it for the list, with Lock and Close buttons. A lock that can pull the latch can also get an Open button (pick its capability, such as open_lock or open); tap it twice to open the door.

Settings: devices, one line or the full list, allow unlocking, the open door button, colour style, time format, rename tiles.

Media

Media on a Homey dashboard: the volume turned up, the next track, mute, the TV as the source from behind ⋯, and a switch to another speaker

One speaker as a card: album art, the track, play controls, mute, and a volume that moves on every tap but never overshoots or passes your maximum. TV and line-in show as such, not as old album art. Tap the name to switch speaker. Up to four buttons behind ⋯ run the speaker's own actions (such as Set source to TV), its app's, or flows; they need an API key (Flows for actions, Start Flows for flows). The large layout puts the album art across the whole widget; tap the art to switch layout (each screen remembers its choice).

Settings: layout (compact or large), tap the album art to switch layout, colour, colour style, speaker, speaker switching, volume as a bar or buttons, volume step and maximum, progress, shuffle and repeat, four buttons with an icon and a name.

Notes

Notes on a Homey dashboard: a blue tile and a yellow Post-it note

A short message on the dashboard: a tile with one line of text, or a tilted, handwritten Post-it note. Type it in the settings, show a Logic text variable, or let a Flow write it with Write [text] on the note [name] (optionally in a colour, such as red for Dryer done) and Clear the note [name]; every Notes widget with that name shows it at once. On the tile, long text is cut off or scrolls; the Post-it wraps it to three lines.

Settings: style (tile or Post-it), text from (the message typed in the settings, a Flow card or a text variable), message, note name, variable, alignment, text size, long text, icon, colour, colour style.

Room Health

Room Health on a Homey dashboard: six rooms with their icons, the kitchen humid, the bedroom stuffy and the office's radon far over

The indoor climate of the whole house on one card. The sensors you pick are grouped by their Homey room: each room shows its worst value large (else the temperature), its name, and a mark per value (an icon, or a bar), lined up in the same order in every room. A comfortable value is grey, or green with Green when fine; outside its range it turns yellow, then red the further out it is. Tap a room to step through its readings.

Value Comfortable by default Red at
Temperature 18–24 °C (18 °C is WHO's minimum) 3 °C outside
Humidity 30–60 % 10 points outside
CO₂ up to 1000 ppm 1.5 × the limit
Radon up to 100 Bq/m³ (WHO's reference level) 1.5 ×
PM2.5 up to 15 μg/m³ (WHO's 24-hour guideline) 1.5 ×
PM10 up to 45 μg/m³ (WHO's 24-hour guideline) 1.5 ×
VOC up to 1000 ppb 1.5 ×

A heat pump's room temperature counts; outdoor and water temperatures don't. Left out on purpose: carbon monoxide (a safety alarm: use Sensor Alarms), air quality indexes and VOC in μg/m³ or as an index (their scales differ between devices), and PM1 (no guideline).

Settings: sensors, rename tiles, colour style, icons or bars, green when fine, the comfortable range of each value (one range for every room).

Sensor Alarms

Sensor Alarms on a Homey dashboard

Tiles that show No alarm, the alarm that's on or how many, and turn red while one is. Every alarm counts, including apps' own such as radon. Tap a tile for all of its alarms.

Settings: sensors, count motion and contact, colour style, rename tiles.

Smart Stack

A Smart Stack on a Homey dashboard: it turns through four widgets, is swiped by hand, and brings the cameras forward when someone is at the door

Widgetkeeper widgets from another dashboard, one at a time in the space of one. It turns every 30 seconds, and swipes or the dots move it by hand. Smart rotate brings a widget forward while something happens on it: music plays, a timer runs, a camera sees someone, a door is open. A Flow card can bring one forward too. Needs an API key with the Homey permission to read the dashboard.

Settings: dashboard, interval, smart rotate, pause after a swipe, dots.

Spacer

Transparent empty space of the height you set, in pixels, to line up widgets across a dashboard's columns. Homey keeps its usual gap above and below it.

Settings: height.

Sparklines

Sparklines on a Homey dashboard

Device Values' tiles with a small live chart of each value and its highest and lowest.

Settings: up to six values, time span (1 hour to 7 days), 2 or 1 per row, colour style, rename tiles.

Thermostat Presets

Thermostat Presets on a Homey dashboard

Three one-tap presets for a thermostat, heat pump or air conditioner, such as Off, Heat 21° and Heat 24° · Fan level 5. The matching preset lights up; a preset without a temperature shows the setpoint under the name. Tap the name for the controls: power, the temperature and every mode, fan or swing setting of the device.

Settings: the device, a title in place of its name, a value to show beside it (any device value, such as the room temperature), compact layout, colour style, and per button: power, mode, temperature and one extra option such as the fan speed.

Timers

Timers on a Homey dashboard: a pizza timer started from its preset, given a minute more, paused and resumed, then run out in red and dismissed

Up to four preset buttons, such as Eggs · 7 min. A started timer takes their place: tap to pause, +1 for a minute more, ✕ to cancel. It beeps and turns red when done. The timer runs on Homey, so every screen sees it and the Flow card A timer finished fires with no dashboard open.

Settings: colour, colour style, four presets with minutes and an optional name, sound.

Value Matrix

Value Matrix on a Homey dashboard: six rooms by temperature, humidity, CO₂ and radon, the kitchen humid and the office's radon far over

Any devices against any values, in one table. Pick the devices, then up to six values for the columns (temperature, humidity, CO₂, power, battery: any number a device has). The rows are the devices' Homey rooms, each cell the average of the room's devices, or the devices themselves with Rows: Devices. A cell is green (OK) inside the column's range, orange (Warning) outside it, and red (Alert) once it's past by half the range; it's striped where a row has no such value.

Type a column's OK range in the value's unit, such as 18–24, <1000 or >10, or – for none. Left empty, the values Room Health knows (temperature in °C, humidity, CO₂, radon, PM2.5, PM10, VOC in ppb) get its ranges, and other values none. The header is the unit (°C, %) or a short name, unless you type your own.

Settings: devices, rename tiles, colour style, rooms or devices as rows, show legend, and per column the value, its OK range and its header.

Variable Presets

Variable Presets on a Homey dashboard

One Logic variable with two to four buttons, each setting it to a value you pick, such as Home, Away and Night for a house mode, or two setpoints. It looks like Thermostat Presets: the button matching the variable lights up in your colour, and when none does, the name shows its value. A yes/no variable without buttons set gets Yes and No. Needs an API key with Variables to change the variable.

Settings: the variable, a title instead of its name, an icon, compact layout, the button colour, colour style, and per button: the value (Yes or No, a number or a text, as the variable is; pick the variable first) and a label.

Variables

Variables on a Homey dashboard

Logic variables as compact rows with their full name: a switch for yes/no, − and + for a number, and the text for a string. Tap a number or text to type a value. Needs an API key with Variables to change them. Read only shows the values without anything to tap (a dot and Yes/No for yes/no), and needs no key.

Settings: up to ten variables, 1 or 2 columns, colour, colour style, read only, the − and + step, the lowest and highest number, rename tiles.

Weather Forecast

Weather Forecast on a Homey dashboard

The next 36 hours from MET Norway (yr.no), hour by hour, with today's and tomorrow's high and low. Swipe sideways to see further ahead.

Settings: compact or detailed, one or two rows, 1–3 hours per column, colour style: Standard, Warm and cold (coloured temperatures) or Vivid (the card on a gradient for the current weather).

Weather data from MET Norway, licensed under CC BY 4.0. Icons: Yr's weather symbols (MIT).

Web dashboards

A web dashboard with Widgetkeeper widgets in a browser window, with Dashboard Shortcuts at the top as a menu

Your Widgetkeeper widgets in any browser at home, or away from home: a wall tablet, an old iPad, a computer or a TV. They're the same widgets, with the same settings and live updates as on a Homey dashboard, on dashboards you build on the page itself. The dashboards are kept on your Homey, so every browser shows the same ones.

Getting started

  1. Open Apps → Widgetkeeper → Configure in the Homey app and turn on Web dashboards.
  2. Open the address shown there in a browser on your home network: http://<your Homey's address>/app/com.thomassidor.widgetkeeper/settings/dashboard.html.
  3. Paste a Homey API key (which permissions), and the web dashboards password if you set one.

Your dashboards

The web dashboards front page in a browser window: seven dashboards as cards, and the widgets you can add

The front page shows every dashboard as a card with a miniature of its widgets, then the widgets you can add. The pen at the top puts it in edit mode: drag the dashboards into order, duplicate one (with its tile names), delete one with a second tap, or hide the widgets. Its Settings has the backup and, for this browser only:

  • Keep screen on while the page is open, for a wall tablet. Browsers only allow this over HTTPS, as on the away from home address; elsewhere the page plays a silent video instead, which works on iPads and iPhones but not in every browser. Where it doesn't, turn off sleep in the device's own settings.
  • Dim: darkens the whole page, up to 80 %, for a wall tablet at night.
  • Forget the key.

Building a dashboard

A web dashboard being edited in a browser window

  • Columns and widgets: one to six columns. Add widgets per column, move them by dragging their bar or with the arrows, and remove them with a second tap.
  • Settings: the same as on a Homey dashboard, in cards: the devices, the general settings, and a folding card per button, tile or column that sums up what's set. Devices are picked from a list grouped by room, with a search.
  • Look: light, dark or automatic, and a background per dashboard (Default, Black or White, Slate, Ocean, Forest, Plum, Berry, Sand), each with a light and a dark shade. The sun button in the bar switches between light and dark in this browser only.
  • Full screen: the corner button gives the whole screen to the dashboard.
  • A menu: put Dashboard Shortcuts on every dashboard to jump between them.

A light web dashboard, the Kitchen on the Sand background, in a browser window

A widget's settings on a web dashboard: Flow Buttons' settings in cards, the first button open

Widgets from other apps

Add widget also lists your other apps' widgets under Other apps, with their own settings. They need Homey in the browser's key, as Homey only lists them with that. They run sealed off, so their code can't read the page or the browser's key. A widget that doesn't work that way can be trusted in its settings (Trust this widget); it then runs as on a Homey dashboard and could read the key.

Away from home

Turn on Remote access under Apps → Widgetkeeper → Configure for a second address, https://<your Homey's id>.connect.athom.com/app/com.thomassidor.widgetkeeper/settings/dashboard.html, through Homey's cloud like the Homey app. A browser asks for the API key again there, as each address is its own site. Anyone with the address still needs a key, but a password is worth setting too.

Password

On top of the API key, you can set a password under Apps → Widgetkeeper → Configure; every browser then asks for it once. Setting, changing or removing it signs every browser out, and repeated wrong passwords lock the sign-in for a while.

Backup

In the front page's Settings, Download backup saves the dashboards you tick in one file: the layouts, the widgets, their settings and tile names. Restore backup lists a file's dashboards; after a second tap, the ones you tick replace those they were saved from (or come back, if deleted), and the others stay as they are. Notes' texts and Days Since's counters aren't included, as Homey's own dashboards share them.

Web dashboards' key

Each browser connects with a key of its own, kept in that browser:

  • A key with the Homey permission works. A narrower one hasn't been tried, as Homey doesn't document which permission an app's own API takes.
  • A widget that changes something needs that permission in the browser's key too, as in the API key table, even though the app's key makes the change.
  • The Smart Stack and other apps' widgets need Homey.

Turning web dashboards off keeps them on your Homey for when you turn them on again.

Dashboard examples

Home A home dashboard with Widgetkeeper widgets on a tablet

Energy An energy dashboard with Widgetkeeper widgets on a tablet

Security A security dashboard with Widgetkeeper widgets on a tablet

Climate A climate dashboard with Widgetkeeper widgets on a tablet

Evening An evening dashboard with Widgetkeeper widgets on a tablet

Garden (light mode) A garden dashboard with Widgetkeeper widgets on a tablet, in Homey's light mode

Kitchen A kitchen dashboard with Widgetkeeper widgets on a tablet

Colour style

Every widget with a coloured state has a Colour style setting: Muted is the calmer look, Vivid the stronger one, and a colour you pick in the widget follows it.

  • Where a colour tints a tile (a Quick Actions tile that's on, a Sensor Alarms alarm, a coloured note, Value Matrix's cells …), Vivid fills the tile with Homey's darker shade, with white text. The charts get a stronger area under their lines.
  • Where the colour is already a small solid part (a lit preset button, Insights Heatmap's cells, Media's play button, Activity Dots' dots), Muted uses the darker shade and Vivid the bright colour.
  • Days Since and Room Health are toned down in Muted and in full colour in Vivid. Weather Forecast's Vivid puts the card on a gradient for the current weather.

Tile names

Rename tiles: the setting turned on, names typed on two Light Controls tiles, and the setting turned off again with the names kept

Give any tile a name of your own, such as Sofa corner for a room's lights, instead of the device's or room's name. Light Controls, Curtains, Device Quick Actions, Sensor Alarms, Room Health, Value Matrix, Device Values, Sparklines, Locks and Doors, Cameras, Variables and (on web dashboards) Dashboard Shortcuts have it.

  1. Edit the dashboard, edit the widget, turn on Rename tiles (the first setting) and save the widget.
  2. Leave the dashboard's edit mode. Each tile now shows a text field: type its name, or leave it empty for the device's (or room's) own.
  3. Edit the widget again and turn Rename tiles off.

The names belong to that widget: they stay with the right tiles when you rename or reorder devices, and every screen and Smart Stack showing the widget gets them.

API key

Homey doesn't let apps change variables, start flows, read dashboards or start Moods on their own. For those, create a key in the Homey web app under Settings → API Keys, tick the permissions below for the widgets you use, and paste it under Apps → Widgetkeeper → Configure. The key stays on your Homey, and that page says what it may do once it's saved.

What Permission to tick Scope
Variables and Variable Presets: changing a value Variables (View Variables isn't enough) homey.logic
Flow Buttons Start Flows homey.flow.start
Media's buttons: a flow Start Flows homey.flow.start
Media's buttons: the speaker's own actions, such as Set source to TV, and its app's Flows (Start Flows isn't enough) homey.flow
Light Controls' Room's Moods: starting a Mood Set Moods homey.mood.set
Smart Stack: reading the dashboard Homey (it allows everything, but there's no permission for dashboards alone) homey

Ticking a group's first box (Flows, Moods, Homey) includes the boxes under it. Everything else needs no key: the widgets read devices, Insights, variables, flows and Moods with Widgetkeeper's own permissions.

Languages

English, Dutch, German, French, Italian, Swedish, Norwegian, Spanish, Danish, Russian, Polish, Korean and Arabic, following Homey's language.

Installation

Install Widgetkeeper from the Homey App Store. The test version has the next version's widgets before they go live. To install it from source with the Homey CLI, see CONTRIBUTING.md.

Troubleshooting

If a widget doesn't work as expected, open Apps → Widgetkeeper → Configure in the Homey app: its Diagnostics report has a device's full details once you pick it, and no passwords, API keys or camera addresses. Include it when you open an issue.

Changelog

See CHANGELOG.md.

License

MIT

About

Widget library for Homey Pro dashboards

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages