Skip to main content

Homey

Show your smart home's devices, energy and climate on TRMNL.

Written by Ryan Kulp

Connecting Homey to TRMNL takes a few minutes and requires no coding. Your Homey sends a snapshot of its devices, zones, energy and climate readings, and TRMNL renders it on your display.

There are two ways to get the data across. Pushing is the one we recommend: your Homey sends to TRMNL on its own schedule, nothing is linked, and it keeps working whether or not you are home. Linking your Homey account is the alternative, where TRMNL fetches from Homey's cloud instead. You only need one of them.

Prerequisites

  • A Homey Pro, which is the model with the local API this uses

  • A TRMNL account, with or without a device

Step 1 - Add the Homey plugin

Inside TRMNL, navigate to Plugins > Homey, then click Save. You do not need to connect an account or pick a device in order to save it.

Saving is what creates your Push URL. Before you save, that field reads "Save this plugin first", because the URL contains an ID that only exists once the plugin is stored. Reopen the plugin after saving and copy the Push URL.

Treat that URL like a password. It is the only credential involved, so anyone who has it can write to your screen.

Step 2 - Send data from your Homey

Pick one of the three options below. The first two send exactly the same thing.

Option A - the TRMNL app (recommended)

Install TRMNL from the Homey App Store, open its settings, and paste your Push URL. That is the whole setup.

The app pushes every 5 minutes by default, and you can change that interval. There is also a setting to push whenever a device changes, which keeps the screen closer to the house. It is off by default, because a home with power metering can spend the hourly push allowance in minutes. Turn it on if you want it, and the app spaces those pushes at least a minute apart.

There is a Test push now button and a diagnostics readout on the same page to confirm it is working.

Option B - HomeyScript

If you would rather not install an app, install Athom's official HomeyScript app instead, then:

  • Copy our push script into a new HomeyScript.

  • Set PUSH_URL at the top of the script to your Push URL.

  • Run it once to check it works.

  • Add a Flow: every 5 minutes, run this script.

Option C - link your Homey account

Instead of your Homey pushing out, TRMNL can pull from Homey's cloud. Click Connect on the plugin's settings form and you are handed to Homey's own login page to authorize TRMNL, the standard OAuth flow. Approve it and you come back to TRMNL, where you pick which Homey and which zone to show.

Nothing gets installed on the Homey with this route, which is the appeal. The trade is that your data travels through Athom's cloud rather than straight from your house to us, and it stops working if you revoke the connection on Homey's side.

Step 3 - Add a screen

The Homey plugin is a data source, not a screen. On its own it will not show you anything useful, so hide it in your playlist.

To see your home, install one of our Homey recipes. Inside TRMNL, search the recipe catalog for Homey:

  • Home Overview - average temperature, humidity and total power, over a device readout.

  • Energy - total power, your biggest consumer, and a per-zone chart.

  • Climate - average temperature and humidity, with a per-sensor breakdown.

  • Home Status - how many devices are on, and any active alarms.

  • Zones - your zones with every device in them.

  • Homey (base recipe) - a starting point to fork and make your own.

After installing one, open its settings and set Homey data source to the Homey plugin you created in Step 1. This is the step people miss most often, and without it the screen has nothing to draw.

Step 4 - You're done!

Give your Homey a few minutes to send its first snapshot, and your screen will fill in.

Fork it and publish your own

The six recipes above are templates, not the final word. We built them to show what the data can do. You know your house and we don't, so if the number you actually care about is buried three rows down, move it.

Open any recipe and choose Fork. You get your own copy of the markup with your Homey already wired in, and you can rearrange it however you like. The components are open source, so browse them at components.trmnl.com and paste in whatever you need.

Then publish it. Published recipes show up in the catalog for every other Homey owner, and the best ones almost always come from someone scratching their own itch rather than from us guessing. Worth reading first: Plugin recipes and Recipe best practices.

Publishing can also pay. The TRMNL Creator Fund shares revenue with plugin authors every month, weighted by things like how long your plugin has been live and how many people use it. Build something Homey owners install, and you earn from it.

Troubleshooting

My recipe is blank, or says it is waiting for data. Nine times out of ten the Homey data source field is not pointed at your Homey plugin. Open the recipe's settings and select it.

The Push URL says "Save this plugin first". Save the plugin, then reopen it. The URL does not exist until the plugin does.

A device is missing. We skip devices Homey reports as unavailable. We also only read a handful of capabilities - power, temperature, humidity, wind, energy, on/off and alarms - so a device with none of those has nothing to show.

Devices show as "Unzoned". They are not assigned to a zone in Homey. Assign them there and they will group correctly on the next push.

My screen is not updating. Two intervals are involved. Your Homey pushes every 5 minutes by default, and your TRMNL refreshes on its own schedule. The screen can only be as fresh as the slower of the two. If you turned on pushing when a device changes and updates have stopped, you are probably over the hourly push allowance, so turn it back off.

I pushed to a private plugin and it was rejected. Pushing to a private plugin on the Webhook strategy requires Developer Edition, and caps the payload at 2 kB (5 kB on TRMNL+). A home of around twenty devices already exceeds that. Use the native Homey plugin's Push URL instead, which has neither limit.

The Homey app and every recipe are open source. If something is wrong, or you want a reading we do not cover, the code is at trmnl-homey-app and trmnl-liquid-components.

Did this answer your question?