Skip to content

About

Widget library for Homey Pro dashboards

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

520 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. Use them on Homey's dashboards, or on web dashboards you build yourself and open in any browser: a wall tablet, an old iPad, a computer or a TV.

Widgetkeeper widgets on a Homey dashboard on a tablet

Contents: Widgets · Web dashboards · Dashboard examples · Colour style · Names · Time format · Temperature · Appearance · 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

Chart · Basic
How did it go? One value over any span up to two years, or against the period before or a second value

Chart · Daily Profile
Today's line over the usual day and its spread: is today unusual?

Chart · Gauge
One value now on a bar or dial, green to red by level if you like: is the air still good?

Chart · Lines
Up to six values over time on one chart, a line each: every room's temperature side by side

Chart · Min/Max
Each day's lowest to highest as a bar: how much did it swing?

Chart · Ranking
One value across devices, now and its range today, sorted: which room is warmest?

Chart · Scatter (XY)
One value against another, a dot an hour: does the heat pump work harder when it's colder?

Chart · Stacked
Several values stacked on one time axis, the rest of a total as Other: who uses the power?

Chart · Timeline
When was it on, open or moving? A row per value over the day

Chart · Totals
How much a value went up per hour, day or month (kWh, rain, hours of TV), like the Energy tab

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

Combined Value
One value of several devices as one: the average, the sum, the lowest or the highest

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

Flow Tiles
Tiles your Flows write: a text or number, an icon, a colour and a fill, and a tap that starts a Flow

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

Keypad
Up to three buttons behind an optional code that start Flows or set a device or variable, with its state beside them

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

Lights by Room
Every room's lights on a card: switch and dim a room, or open it for each light and the room's Moods

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

Pollen and UV
Today's pollen levels and the UV peak, in Europe

Popups
A Flow's message or question with buttons of your own, with a picture if you like, in front of everything on a phone, tablet or web dashboard

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 Board
Every value of the devices you pick in one widget, by room or by device

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)

Web Page
Any web page, scaled to fill the widget, with buttons to switch between addresses

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: a wall tablet, an old iPad, a computer or a cast screen. They're the same widgets, with the same settings and live updates as on a Homey dashboard. The dashboards are kept on your Homey, so every browser shows the same ones.

Getting started

  1. In the Homey app, open Apps → Widgetkeeper → Configure and turn on Web dashboards.
  2. Under Screens and browsers, add the browser to get its sign-in code.
  3. On your home network, open http://<your Homey's address>/app/com.thomassidor.widgetkeeper/settings/dashboard.html and type the code.

Building a dashboard

A web dashboard being edited in a browser window

  • One to six columns, Normal, Narrow, Wide or Fit to window. Drag widgets to move them, copy one to this or another dashboard, or drag its right edge to span several columns.
  • Add widget has a search and groups (Lights and control, Charts, Energy …).
  • The settings are the same as on a Homey dashboard, in cards, with devices picked by room.
  • Light, dark or automatic, with a background per dashboard: a calm tint or a colour of your own. A Widget background slider under it blends the widgets into that background, from their usual look to none at all, with a thin outline keeping them apart at the low end (this app's widgets only).
  • An optional icon per dashboard, from the tile before its name: one of the app's icons or a picture of your own. It shows in the side pane, on the front page and on the browser tab.
  • Add a Popups widget for messages from Flows, and Dashboard Shortcuts for big buttons to your other dashboards on a wall tablet, beside the side pane.
  • For a kiosk browser such as Fully Kiosk, add ?kiosk=1 to the address to hide the dashboard's bar. Add &nav=1 too to keep the side pane there.

Moving between dashboards

A web dashboard in a browser window with the side pane kept open on its left, listing the dashboards

The button at the left of the bar opens a side pane with your dashboards, under the front page's sections. It floats over the widgets until you pick one or tap outside it. On a window at least 1000 px wide, Keep open at the bottom of the pane keeps it beside them, and it stays open as you change dashboards. All dashboards, the front page, is the pane's first row, and on a dashboard the home button beside the pane's button goes straight back to it.

Customize this list at the bottom of the pane chooses what this browser lists: hide a dashboard, a whole section or All dashboards, and drag them into the order you want. Each browser has its own list, so a hallway tablet can show just three dashboards. Hidden dashboards stay on the front page, and new ones appear in the pane by themselves.

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

The front page lists the dashboards; the pen reorders, duplicates and deletes them. Web dashboard settings, at the bottom of the side pane or the sliders beside the pen, has its tabs in two groups. All browsers: Header, your own name and icon in place of Widgetkeeper's (the sign-in screens keep Widgetkeeper's), Sync and the backup. This browser: Screen (light or dark, Keep screen on, Dim, Dim at set times), Kiosk (Rotate dashboards, Go back after a while) and Sign-in (Sign out).

  • Dim at set times: a second level between two times, by the device's clock. The Flow card Dim the web dashboards sets a level too, on every browser or on those showing a dashboard with a Popups widget of that screen name. It lasts until another Flow, a moved slider, or the set times next start or end.
  • Rotate dashboards: tick two or more dashboards and how many seconds each shows (at least 10). A touch pauses it for a minute, and it waits while a dialog, a popup or the editor is open.
  • Go back after a while: after 1 to 120 minutes without a touch, the page returns to the dashboard you pick, or All dashboards. Rotate decides while it's on, and a dashboard with a code, the editor or a dialog holds the page where it is.

Screens and browsers

Each browser signs in with a code of its own, backed by its own Homey API key:

  1. Under Configure → Web dashboards → Screens and browsers, tap Add a screen or browser.
  2. In the Homey web app (Settings → API Keys), make a key with Devices and what the API key table lists for your widgets, and paste it.
  3. Type the code you get, such as K7QM-3XPA, on the page, or open its address or QR code on the screen (handy for one you can't type on, such as a cast Nest Hub).

Opens on sends a screen straight to one dashboard. Remove stops a code; for a lost device, also delete its key in the Homey web app. You can also paste an API key on the page instead of using a code.

Sync with a Homey dashboard

Sync in a dashboard's editor links it to a dashboard in the Homey app, or makes a new one, and keeps the two the same, both ways: on demand, when it's opened and every night (the time is in the side pane's Web dashboard settings).

  • The first sync copies the side you pick. After that, changes on either side reach the other; when the same thing was changed differently on both, the side you picked wins.
  • Homey's own widgets, such as light groups and device tiles, stay on Homey and don't show on the web.
  • It needs a personal API key with the Homey permission in the app settings.

Code

Give a dashboard a Keypad code (the lock in its editor), and leaving or editing it asks for the code, so a wall tablet stays on its dashboard. It guards the screen, not your Homey.

Away from home

Remote access under Configure adds a second address through Homey's cloud: https://<your Homey's id>.connect.athom.com/app/com.thomassidor.widgetkeeper/settings/dashboard.html. It's encrypted, so it's also the one to use at home on a network you don't fully trust.

Password

You can set a password under Web dashboards → Away from home, which every browser is asked for once, on top of its code. If you forget it, the Flow card Remove the web dashboards password removes it.

Backup

In the side pane's Web dashboard settings, Download backup and Restore backup save and bring back the dashboards you tick, with their widgets, settings and tile names. Notes' texts and Days Since's counters aren't included.

Widgets from other apps

Add widget also lists your other apps' widgets. They need a key with the Homey permission and run sealed off from the page; Trust this widget runs one as on Homey, and Size as on Homey scales one made for a phone's width.

Web dashboards' key

  • A widget that changes something needs that permission in the browser's key too (see API key), and switching devices needs Devices. Reading needs nothing extra.
  • The Smart Stack and widgets from other apps need Homey.
  • The home address is plain HTTP, so the key crosses your network unencrypted. On a network you don't fully trust, use the away from home address. Give each screen its own key, so a lost one can be revoked alone.

Turning web dashboards off keeps them on your Homey.

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

Living room A living room 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. Weather Forecast has a Vivid of its own, which puts the card on a gradient for the current weather.

Names

If your device names say more than the device, such as Ceiling lamp | Kitchen, choose under Apps → Widgetkeeper → Configure → Names which part every widget shows: the full name (the default), the part before or after a separator you type, the last word, or the name without its room (Kitchen ceiling lamp in the Kitchen shows as Ceiling lamp).

Under Apply to, tick what it shortens: Devices (ticked unless you untick it), Rooms (the room names on Light Controls, Lights by Room, Curtains, Room Health, Value Matrix and Value Board) and Flows (the names on Flow Buttons). Without the room name only shortens device names.

The page shows a few of your own names as they'll look. Lists in widget settings, Flow tokens and names typed on tiles or buttons stay as they are.

Time format

Every widget that shows a time (the Clock, the charts' axes, the price strips, Timers' end times, since 18:17 …) shows it in 24 or 12 hours as you choose under Apps → Widgetkeeper → Configure → Time format. Automatic (the default) follows the language of the phone or browser that shows the dashboard. Open widgets change at once.

Temperature

Every widget shows temperatures in °C or °F as you choose under Apps → Widgetkeeper → Configure → Temperature. Automatic (the default) follows your Homey's units. A sensor that reports in the other unit is converted too, and temperatures you type in a widget's settings (Room Health's range, Value Matrix's and Combined Value's OK range, a chart's threshold or scale) are in the unit you chose. Open widgets change at once.

Appearance

In light mode, the tiles of the transparent widgets (Light Controls, Lights by Room, Device Quick Actions, Device Values …) have a soft shadow like Homey's own tiles. To turn it off for every widget, untick Shadows under tiles under Apps → Widgetkeeper → Configure → Appearance. Open widgets change at once. Dark mode has no shadow.

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 a tile a name of your own, such as Sofa corner, instead of the device's or room's name, in any widget with a Rename tiles setting:

  1. Edit the widget, turn on Rename tiles and save.
  2. Leave the dashboard's edit mode and type the names on the tiles.
  3. Edit the widget again and turn Rename tiles off.

The names stay with the right tiles when you rename or reorder devices.

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
Keypad: a button with a Flow Start Flows homey.flow.start
Keypad: a button that sets a variable Variables homey.logic
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
Lights by Room: 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
Web dashboards: syncing with a Homey dashboard Homey 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

Most of the icons in the icon settings are from Lucide (ISC, some MIT; licence).

About

Widget library for Homey Pro dashboards

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages