Documentation

Set up the Oura Plugin

Connect your Oura Ring to TRMNL in just a few simple steps. Once connected, your Oura data will automatically be displayed on your TRMNL device.

Getting started

Setting up the Oura plugin is quick and easy. Follow the steps below to connect your Oura account and start displaying your data on TRMNL.

1 Connect your Oura account

On the plugin configuration page, find the Link Account box in the top-right corner.

Click the orange Connect with Oura button to start the secure authorization process.

TRMNL Oura plugin configuration showing the Connect with Oura button
Click Connect with Oura in the Link Account box.
2 Log in to Oura

You will now be taken to Oura's secure login page. Sign in using your Oura credentials.

Depending on your account, Oura may also ask you to enter a one-time password sent to you by Oura.

Secure authorization

Your login is handled by Oura. The TRMNL plugin does not require you to enter your Oura password directly into TRMNL.

3 Confirm access to your Oura data

After logging in, Oura will show you the data types that the TRMNL plugin is requesting access to.

Simply click Submit Consent to confirm.

Oura authorization page showing the requested data permissions
Confirm the requested permissions by clicking Submit Consent.
Important

Please leave all checkboxes enabled. Do not deactivate any of the default permissions before clicking Submit Consent. The plugin will not function properly if one or more of these permissions are disabled.

4 Give your plugin a name

After confirming your consent, you will be redirected back to TRMNL.

Enter a name for this plugin in the Name field. This is required before you can save the plugin.

We recommend using the name of the person wearing the Oura Ring. This makes it easy to distinguish between multiple plugin installations, for example when several people in the same household have their own Oura Ring.

TRMNL Oura plugin configuration showing the Name field
Enter a name for your plugin.
5 Save your configuration

That's it! Click the orange Save button in the top-right corner to complete the setup.

You're all set!

Your Oura account is now connected to the TRMNL plugin.

After setup

Don't worry if your Oura data isn't displayed immediately after saving the plugin.

After the initial setup, the plugin needs to retrieve your data from Oura in the background. This may take a little while.

Give it a moment

Patiently wait for the next scheduled refresh and your Oura data should appear automatically. If you want to speed things up, you can use Force Refresh.

Removing the plugin

If you want to remove the Oura plugin at a later point, you can use the Remove plugin function. This also allows you to delete the data stored for this plugin.

Troubleshooting

No data is displayed

If the plugin has just been configured, please allow some time for the initial data synchronization with Oura to complete.

You can also try clicking Force Refresh to request an update.

Not all data permissions were granted

If one or more of the data types were disabled during the Oura authorization process, the plugin may not function properly.

In this case, the easiest solution is to start the installation again from scratch. Use the Remove plugin function to delete the existing plugin, then create and configure a new installation.

Start fresh if needed

When installing the plugin again, make sure that all data types remain enabled on the Oura consent screen before clicking Submit Consent.

Still having trouble?

If the plugin still does not work after completing the steps above, remove the existing plugin and repeat the installation from the beginning.